List Customer Subscriptions

GET/v2/customers/{id}/subscriptions

Authorization

AuthorizationBearer token · headerrequired

Merchant API key scoped to one merchant and environment. Read operations require api:read, normal write operations require api:write, and broadcast mutations also require explicit broadcasts:write.

Path parameters

idstring<uuid>required

Query parameters

limitinteger

min 1 · max 100 · default: 25

cursorstring

matches ^\d+$

Header parameters

x-request-idstring

Optional caller-provided request correlation ID.

min length 1

Responses

200OK

subscriptionsobject[]required

Show properties

Array of object

idstring<uuid>required

merchantIdstring<uuid>required

environmentstringrequired

Allowed:sandboxproduction

customerIdstring<uuid>required

planNamestringrequired

statusstringrequired

amountHalalasintegerrequired

min 0 · max 9007199254740991

discountHalalasintegerrequired

min 0 · max 9007199254740991

cadenceobjectrequired

Show properties

intervalUnitstringrequired

Allowed:dayweekmonthyear

intervalCountintegerrequired

min -9007199254740991 · max 9007199254740991

currentPeriodStartedAtstring<date-time>required

currentPeriodEndsAtstring<date-time>required

scheduledCancellationAtstring<date-time> | anyrequired

Show properties

Any of:

string<date-time>

string<date-time>

any

any

createdAtstring<date-time>required

nextCursorstring | anyrequired

Show properties

Any of:

string

string

any

any

401Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

403Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

404Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

409Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

422Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

429Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

500Standard Cipay error response.

errorobjectrequired

Show properties

codestringrequired

min length 1

messagestringrequired

min length 1

requestIdstringrequired

min length 1

detailsobject

Request

curl -X GET "https://api.cipay.net/v2/customers/%3Cuuid%3E/subscriptions" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch("https://api.cipay.net/v2/customers/%3Cuuid%3E/subscriptions", {
  method: "GET",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN"
  }
});

Response

{
  "subscriptions": [
    {
      "id": "<uuid>",
      "merchantId": "<uuid>",
      "environment": "sandbox",
      "customerId": "<uuid>",
      "planName": "string",
      "status": "string",
      "amountHalalas": 0,
      "discountHalalas": 0,
      "cadence": {
        "intervalUnit": "day",
        "intervalCount": 0
      },
      "currentPeriodStartedAt": "2024-01-01T00:00:00Z",
      "currentPeriodEndsAt": "2024-01-01T00:00:00Z",
      "scheduledCancellationAt": "2024-01-01T00:00:00Z",
      "createdAt": "2024-01-01T00:00:00Z"
    }
  ],
  "nextCursor": "string"
}