Plans
List plans
Plans
List plans
GET
/
plans
curl --request GET \
--url https://api.sulu.sh/v0/plans \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "<string>",
"object": "plan",
"name": "<string>",
"invoiceDisplayName": "<string>",
"description": "<string>",
"billingInterval": "<string>",
"currency": "<string>",
"merchantId": "<string>",
"productId": "<string>",
"tax": {},
"prices": [
{
"id": "<string>",
"object": "price",
"billableMetricId": "<string>",
"model": "standard",
"invoiceDisplayName": "<string>",
"properties": {
"unitPrice": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Unique identifier for an organization
Filter plans by product ID
Required range:
1 <= x <= 100
Required range:
x >= 0
Response
200
application/json
List of plans
Unique identifier for a plan
Available options:
plan
The merchant organization that owns this plan
The product this plan belongs to
Unique identifier for a price
Available options:
price
Unique identifier for a billable metric
Available options:
standard
, dynamic
, volume
curl --request GET \
--url https://api.sulu.sh/v0/plans \
--header 'Authorization: Bearer <token>'
{
"data": [
{
"id": "<string>",
"object": "plan",
"name": "<string>",
"invoiceDisplayName": "<string>",
"description": "<string>",
"billingInterval": "<string>",
"currency": "<string>",
"merchantId": "<string>",
"productId": "<string>",
"tax": {},
"prices": [
{
"id": "<string>",
"object": "price",
"billableMetricId": "<string>",
"model": "standard",
"invoiceDisplayName": "<string>",
"properties": {
"unitPrice": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"pagination": {
"limit": 123,
"offset": 123,
"total": 123
}
}