List subscriptions, optionally by customer

GET

/api/v1/subscriptions

const url = 'https://example.com/api/v1/subscriptions';
const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/subscriptions \
  --header 'x-api-key: <x-api-key>'

Authorizations

x-api-key

Parameters

Query Parameters

customerId

string

limit

page

Responses

200

application/json

object

data

required

Array<object>

object

required

string

stripeSubscriptionId

required

string

customerId

required

string

planId

required

string

status

required

string

Allowed values: active canceled incomplete incomplete_expired trialing past_due unpaid

currentPeriodStart

required

string format: date-time

nullable

currentPeriodEnd

required

string format: date-time

nullable

trialEnd

required

string format: date-time

nullable

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

total

required

number

page

required

number

limit

required

number

Example

{
  "data": [
    {
      "status": "active"
    }
  ]
}