GET
/
v1
/
plans
/
{id}

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Response

200 - application/json
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.

contract_end
string | null
required

Contract end date, applicable if the end strategy is end_date.

contract_end_strategy
enum<string>
required

Strategy used to trigger the end of the subscription contract.

Available options:
duration,
manual,
end_date
contract_start
string | null
required

Contract start date, applicable if the start strategy is start_date.

contract_start_strategy
enum<string>
required

Strategy used to trigger the start of the subscription contract.

Available options:
start_date,
immediately,
manual,
manual_with_latest,
quote_signature,
checkout
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.

description
string | null
required

Plan description.

id
string
required

Plan ID.

name
string
required

Plan name.

products
object[]
required
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.