GET
/
v1
/
plans
/
{id}

Authorizations

Authorization
string
headerrequired

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

Path Parameters

id
string
required

Response

200 - application/json
id
string
required

Plan ID.

name
string
required

Plan name.

description
string | null
required

Plan description.

commitment_interval
object | null
required

Interval used to represent the commitment period of the plan.

contract_duration
object | null
required

Duration of the initial contract for the created subscription.

renew_automatically
boolean
required

Indicates if the subscription to the plan should automatically renew.

renew_for
object | null
required

Interval to renew thr subscription for if renew_automatically is enabled.

trial_interval
object | null
required

Interval used to represent the trial period of the plan.

products
object[]
required
custom_properties
object | null
required

A list of key value with the ID or the name of the custom property as the key and the custom property value as value.

Was this page helpful?

Get plansUpdate prices