v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

Fetch customer's subscriptions

Use /customers/:customerId/subscriptions endpoint to fetch customer's subscriptions. This endpoint lists all active and stopped subscriptions, but it doesn't return expired ones.

You can find details about customer subscriptions here, like status, expiration date, price, payment method, or period.

NOTE: This API requires <glossary:JWT> to run. It should be put in the request header. See more in Authorization.

get/customers/{customerId}/subscriptions

Path parameters

customerIdstring required

Customer identifier at Cleeng

Response

200

Example response

{
  "responseData": {
    "items": [
      {
        "subscriptionId": 590680399,
        "offerId": "S568296139_ZW",
        "status": "active",
        "startedAt": 1653054759,
        "expiresAt": 1654264359,
        "nextPaymentPrice": 5,
        "nextPaymentCurrency": "EUR",
        "nextPaymentAt": 1654048359,
        "paymentGateway": "adyen",
        "paymentMethod": "card",
        "externalPaymentId": "undefined",
        "inTrial": true,
        "offerTitle": "Monthly subscription (recurring) to pride&amp;prejudice",
        "period": "month",
        "totalPrice": 5
      }
    ]
  }
}