Retrieve a plan

Returns the details of a specific plan, including all of its price options.

GET

Headers

string

The Bearer token for authentication.

string

The user agent of the request. Must contain at least two identifiers separated by a space.

string

The content type of the request.

Parameters

string

The ID of the plan to retrieve.

boolean

Filter by active options only.

Response Body

application/json
boolean

Indicates that the request was successful.

object

The plan data.

string

The ID of the plan.

string

The title of the plan.

string

The summary of the plan.

string

The type of the plan.

standardmetered
string

The currency of the plan.

date-time

The date and time the plan was created.

array

The list of options attached to the plan.

string

The ID of the plan option.

string

The description of the plan option.

boolean

Whether the plan option is active.

number

The unit price of the plan option.

number

The billing interval of the plan option.

number

The number of subscribers to the plan option.

object

The attributes of the plan option.

date-time

The date and time the plan option was created.