API referenceSubscription plans
Get a subscription plan
GET
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 ).
planId*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- response
id*stringenvironment*stringValue in
"SANDBOX""LIVE"name*stringdescription*string|nullamountMinor*stringcurrency*stringbillingCycle*stringValue in
"WEEKLY""MONTHLY""QUARTERLY""BIANNUALLY""ANNUALLY"status*stringValue in
"ACTIVE""ARCHIVED"features*array<string>What's included (up to 8 lines).
highlight*|Badge on the subscribe page.
subscriptionId*|The subscription offering this plan.
position*numberDisplay order within the subscription.
createdAt*stringupdatedAt*stringcurl -X GET 'https://api.creddot.com/api/v1/subscription-plans/string' \ -H 'x-idempotency-key: string'Example Response
{ "id": "string", "environment": "SANDBOX", "name": "string", "description": "string", "amountMinor": "string", "currency": "string", "billingCycle": "WEEKLY", "status": "ACTIVE", "features": [ "string" ], "highlight": "string", "subscriptionId": "string", "position": 0, "createdAt": "string", "updatedAt": "string"}