API referenceSubscriptions
Update a subscriber status
PATCH
api-keyheader
x-api-key<token>Your API key: ck_test_... for test mode, ck_live_... for live. Send it with x-api-secret (or Authorization: Bearer ).
subscriptionId*stringsubscriberId*stringx-api-secret?stringRecommended: 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?stringLegacy signed mode: Unix time in milliseconds; maximum clock skew five minutes.
x-signature?stringLegacy signed mode: HMAC-SHA256(secret, timestamp.METHOD.url.idempotencyKey.bodyHash).
x-idempotency-key*string1–128 letters/digits or ._:-. Same key and payload replay for 24 hours; conflicting, in-flight, or expired keys return 409. Never change a key to retry an uncertain payment.
application/json- body
status*stringValue in
"PENDING""PROCESSING""ACTIVE""CANCELLED"paymentMethod?stringLength
length <= 40application/json- response
id*stringorderCode*stringcustomerId*string|nullcustomerName*stringcustomerEmail*stringamountMinor*stringcurrency*stringpaymentMethod*string|nullstatus*stringValue in
"PENDING""PROCESSING""ACTIVE""OVERDUE""LAPSED""CANCELLED"customerPhone*string|nulllastPaidAt*string|nulloverdueAt*string|nulllapsedAt*string|nullplanId*string|nullplanName*string|nullbillingCycle*|Value in
"WEEKLY""MONTHLY""QUARTERLY""BIANNUALLY""ANNUALLY"startedAt*string|nullnextBillingAt*string|nullcancelledAt*string|nullcreatedAt*stringcurl -X PATCH 'https://api.creddot.com/api/v1/subscriptions/string/subscribers/string/status' \ -H 'x-idempotency-key: string' \ -H 'Content-Type: application/json' \ -d '{ "status": "PENDING"}'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"}