Start a new checkout session for renewing a subscription.
const url = 'https://api.example.com/cms/customer/subscription/1/checkout';const options = { method: 'POST', headers: { 'API-Key': '<API-Key>', Authorization: 'Bearer <token>', Token: '<Token>', 'Content-Type': 'application/json' }, body: '{"payment_method":"","ip_address":"","country":"NL","source":"example","page":"example","button":"example","properties":{}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.example.com/cms/customer/subscription/1/checkout \ --header 'API-Key: <API-Key>' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Token: <Token>' \ --data '{ "payment_method": "", "ip_address": "", "country": "NL", "source": "example", "page": "example", "button": "example", "properties": {} }'Use this when the initial renewal attempt failed and you need to collect payment details again. This will create a new unpaid payment and return the checkout session details from the payment provider.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Subscription ID
Request Body
Section titled “Request Body”object
Optional payment method to use for this renewal. If not provided, the existing payment method on the subscription will be used.
Example
IP address of the customer. If not provided, the IP address from the request will be used.
Example
Country of the customer. If not provided, the country will be determined based on the IP address.
Example
NLSource (web, app, etc.)
Source page URL
Source button
Additional properties to save for this payment, such as UTM parameters, coupon code, affiliate info, etc.
object
Responses
Section titled “Responses”Renewal successful
object
Indicates if request for renewal was successful. If not, only the subscription details are returned.
Payment provider response
object
API representation of a payment
object
Payment ID
Order amount (DB decimal serialized as a string)
Order currency
Order amount in base currency (DB decimal serialized as a string)
Payment status
Response message
Last update timestamp, MySQL datetime (Y-m-d H:i:s)
Payment timestamp, MySQL datetime (Y-m-d H:i:s)
User ID
Payment method
Renewal ID
Cart items
object
Purchased product item. Currently serialized as a string reference of the form “WhiteBeard\ECommerce\ProductItems:
API representation of an ecommerce pricing tier (product item)
object
Item ID
Description
Product ID
Product name
Price
The price it sells at today: its timed offer’s price while one runs, otherwise price
Currency
Available
Item order
Shippable
Weight
Installments
Once per user
Is upgrade
Upgrade type
Upgrade from
Upgrade exclude items
Upgrade price web
Upgrade price mobile
Field values, keyed by field key (each {name, value, type}), e.g. {“size”: {“name”: “Size”, “value”: “large”, “type”: “list”}}: the same keys the product search takes in settings; an empty array when there are none
object
object
Has image
Additional label 1
Additional label 2
Additional label 3
Diameter
Length
Depth
Width
Recurrent
Recurrent price
Recurrent start
Recurrent schedule
SKU
Stock enabled
Stock available
Whether orders are accepted when out of stock
Package quantity
Related items
object
Images (attachments)
object
High resolution URL
Video (only for video attachments)
object
Duration (only when present in metadata)
Files (attachments)
object
Duration (only when present in metadata)
Product details. Deprecated to avoid circular references. Use productId instead.
object
Translations
Action data to be executed when a pricing tier is bought
object
Action data to be executed when a pricing tier is bought as a renewal
object
Price matrix
object
Subtotal amount
Shipping amount
Tax amount
Discount amount
Total amount
Shipping status. “delivered” means digitally delivered (no physical product); “shipped_delivered” is a physical shipment that arrived.
Shipment tracking number: from the shipping provider when it created the shipment, or set by hand on the order. Null when there is none.
Authorization
Shipping price
Tax price
Reference order ID
Source of the payment (such as website or mobile app store)
Payment properties: those sent when the payment was created (such as UTM parameters, coupon code, affiliate info, stripe_mode), and those the system keeps on it (such as renewal_id, or payment method and CRM sync details)
object
API representation of a customer subscription
object
Subscription ID
Activation date, MySQL datetime (Y-m-d H:i:s)
Deactivation date, MySQL datetime (Y-m-d H:i:s); “0000-00-00 00:00:00” when not set
User ID
Status (“1” enabled, “0” disabled)
Purchased item
API representation of an ecommerce pricing tier (product item)
object
Item ID
Description
Product ID
Product name
Price
The price it sells at today: its timed offer’s price while one runs, otherwise price
Currency
Available
Item order
Shippable
Weight
Installments
Once per user
Is upgrade
Upgrade type
Upgrade from
Upgrade exclude items
Upgrade price web
Upgrade price mobile
Field values, keyed by field key (each {name, value, type}), e.g. {“size”: {“name”: “Size”, “value”: “large”, “type”: “list”}}: the same keys the product search takes in settings; an empty array when there are none
object
object
Has image
Additional label 1
Additional label 2
Additional label 3
Diameter
Length
Depth
Width
Recurrent
Recurrent price
Recurrent start
Recurrent schedule
SKU
Stock enabled
Stock available
Whether orders are accepted when out of stock
Package quantity
Related items
object
Images (attachments)
object
High resolution URL
Video (only for video attachments)
object
Duration (only when present in metadata)
Files (attachments)
object
Duration (only when present in metadata)
Product details. Deprecated to avoid circular references. Use productId instead.
object
Translations
Action data to be executed when a pricing tier is bought
object
Action data to be executed when a pricing tier is bought as a renewal
object
Next renewal date, MySQL datetime (Y-m-d H:i:s)
Renewal attempts (DB integer serialized as a string)
Group code
Group name
Payment method
Cancellation request date, MySQL datetime (Y-m-d H:i:s)
Cancellation reason
Cancellation reason (custom user text)
Currency
Subscription is in grace period
Computed status code. 1=Active, 2=Active (grace period), 3=On hold (retrying), 4=Active (Pending user cancellation), 5=User cancelled, 6=On hold, 7=Active (Renewal disabled), 8=Not started, 9=Upgraded, 10=Paused
Computed status code as human-readable text
Example
{ "payment": { "price": "12", "price_baseCurrency": "12", "lastUpdate": "2026-09-29 13:22:40", "timestamp": "2026-09-18 14:46:39", "cart": [ { "item": "WhiteBeard\\ECommerce\\ProductItems:133", "price": 12 } ], "shippingStatus": "waiting", "shippingTrackingNumber": "1Z999AA10123456784", "address": "[]", "shipping_address": "[]", "properties": { "utm_source": "newsletter", "renewal_id": 3 } }, "subscription": { "activationDate": "2026-09-18 15:30:29", "deactivationDate": "2026-10-18 15:30:29", "status": "1", "purchased_item": { "prices": { "ZAR": { "price": "1", "recurrentPrice": "1" } }, "images": [ { "id": "4", "name": "watermarked", "focal": "50% 50%", "image_width": 654, "image_height": 529, "type": "image" } ], "files": [ { "id": "5", "type": "file" } ], "translations": { "en": { "description": "Description text", "label1": "Label 1", "label2": "Label 2", "label3": "Label 3" } }, "action_data": [ { "function": "registerSubscription", "param": "365", "group": "subscription" } ], "action_data_renew": [ { "function": "registerSubscription", "param": "365", "group": "subscription" } ] }, "nextRenewal": "2026-10-18 15:30:29", "lastFailedOrder": "20241", "attempts": "0", "referenceOrderId": "20241", "cancellationRequestDate": "2026-09-18 15:30:29", "status_code": 1 }}Bad Request
Unauthorized
Subscription not found