Skip to main content

Create product

Create a new product for platform.

Request Body required
    body object
    name string
    title string
    description string
    plan_id string
    prices object[]
  • Array [
  • id string
    product_id string
    provider_id string
    name string
    interval known intervals are "day", "week", "month", and "year"
    usage_type usage_type known types are "licensed" and "metered"
    billing_scheme billing_scheme known schemes are "tiered" and "flat"
    state string
    currency currency like "usd", "eur", "gbp"
    amount int64
    metered_aggregate metered_aggregate known aggregations are "sum", "last_during_period" and "max"
    tier_mode tier_mode known modes are "graduated" and "volume"
    metadata object
    created_at date-time
    updated_at date-time
  • ]
  • behavior string
    features object[]
  • Array [
  • id string
    name machine friendly name
    product_ids string[]
    title human friendly name
    metadata object
    created_at date-time
    updated_at date-time
  • ]
  • behavior_config object
    credit_amount int64
    seat_limit int64
    min_quantity int64
    max_quantity int64
    metadata object
Responses

A successful response.


Schema
    product object
    id string
    name string
    title string
    description string
    plan_ids string[]
    state string
    prices object[]
  • Array [
  • id string
    product_id string
    provider_id string
    name string
    interval known intervals are "day", "week", "month", and "year"
    usage_type usage_type known types are "licensed" and "metered"
    billing_scheme billing_scheme known schemes are "tiered" and "flat"
    state string
    currency currency like "usd", "eur", "gbp"
    amount int64
    metered_aggregate metered_aggregate known aggregations are "sum", "last_during_period" and "max"
    tier_mode tier_mode known modes are "graduated" and "volume"
    metadata object
    created_at date-time
    updated_at date-time
  • ]
  • behavior string
    features object[]
  • Array [
  • id string
    name machine friendly name
    product_ids string[]
    title human friendly name
    metadata object
    created_at date-time
    updated_at date-time
  • ]
  • behavior_config object
    credit_amount int64
    seat_limit int64
    min_quantity int64
    max_quantity int64
    metadata object
    created_at date-time
    updated_at date-time
POST /v1beta1/billing/products

Authorization

name: Basic type: httpdescription: use Client ID as username and Client Secret as passwordin: headerscheme: basic

Request

Base URL
http://127.0.0.1:7400
Security Scheme
Username
Password
Body required
{
"body": {
"name": "string",
"title": "string",
"description": "string",
"plan_id": "string",
"prices": [
{
"id": "string",
"product_id": "string",
"provider_id": "string",
"name": "string",
"interval": "string",
"usage_type": "string",
"billing_scheme": "string",
"state": "string",
"currency": "string",
"amount": "string",
"metered_aggregate": "string",
"tier_mode": "string",
"metadata": {},
"created_at": "2024-07-13T09:54:48.185Z",
"updated_at": "2024-07-13T09:54:48.185Z"
}
],
"behavior": "string",
"features": [
{
"id": "string",
"name": "string",
"product_ids": [
"string"
],
"title": "string",
"metadata": {},
"created_at": "2024-07-13T09:54:48.185Z",
"updated_at": "2024-07-13T09:54:48.185Z"
}
],
"behavior_config": {
"credit_amount": "string",
"seat_limit": "string",
"min_quantity": "string",
"max_quantity": "string"
},
"metadata": {}
}
}
curl / cURL
curl -L -X POST 'http://127.0.0.1:7400/v1beta1/billing/products' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"body": {
"name": "string",
"title": "string",
"description": "string",
"plan_id": "string",
"prices": [
{
"id": "string",
"product_id": "string",
"provider_id": "string",
"name": "string",
"interval": "string",
"usage_type": "string",
"billing_scheme": "string",
"state": "string",
"currency": "string",
"amount": "string",
"metered_aggregate": "string",
"tier_mode": "string",
"metadata": {},
"created_at": "2024-07-13T09:54:48.185Z",
"updated_at": "2024-07-13T09:54:48.185Z"
}
],
"behavior": "string",
"features": [
{
"id": "string",
"name": "string",
"product_ids": [
"string"
],
"title": "string",
"metadata": {},
"created_at": "2024-07-13T09:54:48.185Z",
"updated_at": "2024-07-13T09:54:48.185Z"
}
],
"behavior_config": {
"credit_amount": "string",
"seat_limit": "string",
"min_quantity": "string",
"max_quantity": "string"
},
"metadata": {}
}
}'