logo

Retrieve plans

Retrieves a list of plans.

SecuritySecretApiKey or JWT or ApplicationJWT
Request
query Parameters
filter
string

Filters the collection items. This field requires a special format. Use , for multiple allowed values. Use ; for multiple fields.

For more information, see Using filter with collections.

sort
Array of strings

Sorts and orders the collection of items. To sort in descending order, prefix with -.

limit
integer [ 0 .. 1000 ]

Limits the number of collection items to be returned.

offset
integer >= 0

Specifies the starting point within the collection of items to be returned.

q
string

Use this field to perform a partial search of text fields.

Responses
200

List of plans retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
Array
One of:
name
required
string <= 255 characters

Name of the plan. This name is displayed on invoices and receipts.

currency
required
string (CurrencyCode) = 3 characters

Currency code in ISO 4217 format.

productId
required
string <= 50 characters

Related product ID.

required
object (PlanPriceFormula)

Pricing information.

price
required
number <double>

Use this formula to charge for subscriptions that have a fixed price, number of units, and reoccur over a fixed period of time, such as every: day, week, month, year, or number of years.

For example, a streaming company charges customers $13.99 each month for subscription period that is 6 months in duration. The quantity of movies that a customer streams each month does not impact the price.

formula
required
string

Price formula that determines which algorithm is used to calculate the invoice price based on the following factors:

  • Quantity in the order. This value may be variable if you are charging based on usage. If you are not charging based on usage, this value is determined when an order is created.

  • Price of the quantity range. Some formulas set a price based on defined product quantity ranges.

For more information, see Price formulas.

id
string <= 50 characters

ID of the plan.

description
string

Plain-text description of the plan. This field accepts plain-text only.

richDescription
string

Rich-text description of the plan. This field accepts rich text formatting, such as: bold, underline, italic, and hyperlinks.

object or null

Name-value pairs that specify the product options.

property name*
additional property
string
currencySign
string

Currency sign.

object or null

Set up information of the plan.

price
required
number <double>

Price of setting up the plan. If your service charges a set up fee, specify it here. To charge no set up fee, set this value to 0.

customFields
object (ResourceCustomFields)
Default: {}

Use custom fields to extend a resource scheme to include custom data that is not provided as a common field. For more information, see Custom fields.

isActive
boolean

Specifies if the plan is active.

revision
integer

Number of times the plan is modified. Compare this value with materialized subscription item revision values.

createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

isTrialOnly
boolean

Specifies if a plan is a trial that does not have recurring instructions.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/plans
Request samples 
$plans = $client->plans()->search([
    'filter' => 'name:TestPlan',
]);
Response samples
application/json
[
  • {
    }
]
➔ Next to Create a plan