API referenceSubscriptions
Update a subscription
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*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
name?stringLength
length <= 160planId?stringMake another plan of this subscription the default.
description?|Length
length <= 5000amountMinor?stringChanges the default plan price.
billingCycle?stringChanges the default plan cycle.
Value in
"WEEKLY""MONTHLY""QUARTERLY""BIANNUALLY""ANNUALLY"startAt?stringFormat
date-timeautoRenewal?booleanrenewalReminders?booleanallowPlanUpgrade?booleangracePeriodDays?numberRange
0 <= value <= 30curl -X PATCH 'https://api.creddot.com/api/v1/subscriptions/string' \ -H 'x-idempotency-key: string' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
Empty