Create a subscription
api-keyx-api-key<token>Your API key: ck_test_... for test mode, ck_live_... for live. Send it with x-api-secret (or Authorization: Bearer ).
x-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
name*stringlength <= 160plans?array<>The plans offered (1–10); the first is the default. Required unless planId is given.
planId?stringLegacy: an existing plan in the same environment, copied onto this subscription as its only plan. Use plans instead.
description?stringlength <= 5000amountMinor?stringLegacy (with planId): overrides the copied plan amount.
billingCycle?stringLegacy (with planId): overrides the copied plan cycle.
"WEEKLY""MONTHLY""QUARTERLY""BIANNUALLY""ANNUALLY"startAt?stringDefaults to now.
date-timestatus?string"ACTIVE""DRAFT""ACTIVE"autoRenewal?truerenewalReminders?trueallowPlanUpgrade?truegracePeriodDays?numberDays after a missed billing date before a subscriber lapses.
0 <= value <= 303application/json- response
id*stringsubscriptionCode*stringenvironment*string"SANDBOX""LIVE"name*stringdescription*string|nullplanId*stringplanName*stringamountMinor*stringcurrency*stringbillingCycle*stringstatus*string"DRAFT""ACTIVE""CANCELLED"startAt*stringnextBillingAt*stringautoRenewal*booleanrenewalReminders*booleanallowPlanUpgrade*booleanslug*|Public share code (checkout /sub/{slug}).
shareUrl*|Hosted subscribe page, while the subscription is active.
gracePeriodDays*numberDays after a missed billing date before a subscriber lapses.
activatedAt*string|nullcancelledAt*string|nullcreatedAt*stringupdatedAt*stringplan*The default plan.
plans*array<>Every plan of this subscription, in display order (archived included).
progress*recentSubscribers*array<>curl -X POST 'https://api.creddot.com/api/v1/subscriptions' \ -H 'x-idempotency-key: string' \ -H 'Content-Type: application/json' \ -d '{ "name": "Meaty Enterprise"}'{ "id": "string", "subscriptionCode": "string", "environment": "SANDBOX", "name": "string", "description": "string", "planId": "string", "planName": "string", "amountMinor": "string", "currency": "string", "billingCycle": "string", "status": "DRAFT", "startAt": "string", "nextBillingAt": "string", "autoRenewal": true, "renewalReminders": true, "allowPlanUpgrade": true, "slug": "string", "shareUrl": "string", "gracePeriodDays": 0, "activatedAt": "string", "cancelledAt": "string", "createdAt": "string", "updatedAt": "string", "plan": { "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" }, "plans": [ { "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", "isDefault": true, "activeSubscribers": 0, "subscribers": 0 } ], "progress": { "total": 0, "active": 0, "cancelled": 0, "pending": 0, "processing": 0, "overdue": 0, "lapsed": 0, "percentageActive": 0, "collectedAmountMinor": "string" }, "recentSubscribers": [ { "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" } ]}