GET
/
v2
/
price_plans
/
{price_plan_id}
curl --request GET \
  --url https://api.togai.com/v2/price_plans/{price_plan_id} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "description": "<string>",
  "type": "BILLING",
  "pricingCycleConfig": {
    "interval": "WEEKLY",
    "startOffset": {
      "dayOffset": "<string>",
      "monthOffset": "<string>"
    },
    "gracePeriod": 3,
    "anniversaryCycle": true
  },
  "supportedCurrencies": [
    "<string>"
  ],
  "deferredRevenue": true,
  "allowOngoingCycleUpdates": true,
  "id": "<string>",
  "referenceId": "<string>",
  "version": 123,
  "status": "DRAFT",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
price_plan_id
string
required
Maximum length: 50
Example:

"pp.1zYnCiM9Bpg.lv25y"

Query Parameters

​
version
string

Optional version to get a specific version. Gets latest version if it is not provided. Possible values:

  1. LATEST - Get the latest version of the price plan, can be draft
  2. ACTIVE - Get the latest active version of the price plan
  3. NUMBER - Get the specific version of the price plans

Response

200
application/json

Response for Create and Get price plan requests

Request to create a price plan

GET
/
v2
/
price_plans
/
{price_plan_id}
curl --request GET \
  --url https://api.togai.com/v2/price_plans/{price_plan_id} \
  --header 'Authorization: Bearer <token>'
{
  "name": "<string>",
  "description": "<string>",
  "type": "BILLING",
  "pricingCycleConfig": {
    "interval": "WEEKLY",
    "startOffset": {
      "dayOffset": "<string>",
      "monthOffset": "<string>"
    },
    "gracePeriod": 3,
    "anniversaryCycle": true
  },
  "supportedCurrencies": [
    "<string>"
  ],
  "deferredRevenue": true,
  "allowOngoingCycleUpdates": true,
  "id": "<string>",
  "referenceId": "<string>",
  "version": 123,
  "status": "DRAFT",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
price_plan_id
string
required
Maximum length: 50
Example:

"pp.1zYnCiM9Bpg.lv25y"

Query Parameters

​
version
string

Optional version to get a specific version. Gets latest version if it is not provided. Possible values:

  1. LATEST - Get the latest version of the price plan, can be draft
  2. ACTIVE - Get the latest active version of the price plan
  3. NUMBER - Get the specific version of the price plans

Response

200
application/json

Response for Create and Get price plan requests

Request to create a price plan