CreddotDocsCreddot Docs
API referenceSubscriptions

List a subscription's subscribers

Filter by email to check one customer. Accepts the subscription ID or code (SUB-001). Up to 100, newest first.

GET
/api/v1/subscriptions/{subscriptionId}/subscribers

Filter by email to check one customer. Accepts the subscription ID or code (SUB-001). Up to 100, newest first.

Authorization

api-key
headerx-api-key<token>

Your API key: ck_test_... for test mode, ck_live_... for live. Send it with x-api-secret (or Authorization: Bearer ).

Path Parameters

subscriptionId*string

Query Parameters

email?string

Find a customer's subscription by email.

Formatemail
status?string
Value in"PENDING""PROCESSING""ACTIVE""OVERDUE""LAPSED""CANCELLED"

Header Parameters

x-api-secret?string

Recommended: API secret sent over HTTPS. You may send it as Authorization: Bearer instead. If supplied, x-timestamp and x-signature are not required.

x-timestamp?string

Legacy signed mode: Unix time in milliseconds; maximum clock skew five minutes.

x-signature?string

Legacy signed mode: HMAC-SHA256(secret, timestamp.METHOD.url.idempotencyKey.bodyHash).

Response Body

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://api.creddot.com/api/v1/subscriptions/string/subscribers'
Example Response
[  {    "id": "string",    "orderCode": "string",    "customerId": "string",    "customerName": "string",    "customerEmail": "string",    "amountMinor": "string",    "currency": "string",    "paymentMethod": "string",    "status": "PENDING",    "customerPhone": "string",    "lastPaidAt": "string",    "overdueAt": "string",    "lapsedAt": "string",    "planId": "string",    "planName": "string",    "billingCycle": "WEEKLY",    "startedAt": "string",    "nextBillingAt": "string",    "cancelledAt": "string",    "createdAt": "string"  }]