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

​
Authorization
string
header
required

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

Query Parameters

​
merchantId
string

Unique identifier for an organization

​
productId
string

Filter plans by product ID

​
limit
integer
default:10
Required range: 1 <= x <= 100
​
offset
integer
default:0
Required range: x >= 0

Response

200
application/json
List of plans
​
data
object[]
​
pagination
object

Offset-based pagination response.