Skip to main content
GET
/
customers
/
{customerId}
/
subscriptions
/
List customer subscriptions
curl --request GET \
  --url https://provider.api.nadles.com/v0/customers/{customerId}/subscriptions/ \
  --header 'nadles-provider-key: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "vendor_id": "<string>",
      "product_id": "<string>",
      "customer_id": "<string>",
      "order_id": "<string>",
      "state": "<string>",
      "psp_name": "<string>",
      "billing_version": 123,
      "is_cancelation_scheduled": true,
      "items": [
        {}
      ],
      "activated_at": "2023-11-07T05:31:56Z",
      "expired_at": "2023-11-07T05:31:56Z",
      "cancellation_scheduled_at": "2023-11-07T05:31:56Z",
      "canceled_at": "2023-11-07T05:31:56Z",
      "past_due_at": "2023-11-07T05:31:56Z"
    }
  ],
  "metadata": {
    "pagination": {
      "limit": 123,
      "offset": 123,
      "total": 123
    }
  }
}

Authorizations

nadles-provider-key
string
header
required

API key provided in the admin portal

Path Parameters

customerId
string
required

The ID of the customer.

Query Parameters

limit
integer

Maximum number of items to return

offset
integer

Number of items to skip before starting to collect the result set

state
string

Filter subscriptions by state

Response

200 - application/json

OK

data
object[]
metadata
object