Skip to main content
POST
Pay billing periods in advance
This reference describes API version 2026-08-27. Send Commet-Version: 2026-08-27 with your request.

Authorizations

x-api-key
string
header
required

Headers

Idempotency-Key
string

Unique key used to safely retry this write for 24 hours without applying it twice.

Required string length: 1 - 200
Commet-Version
string
default:2026-08-27

API version used by this reference. Send this header to select this contract explicitly.

Path Parameters

id
string
required

Body

application/json
periods
integer
required

Active subscriptions: billing periods to add after the last paid period. Pending-payment subscriptions: total billing periods the first payment covers, including the current one.

Required range: 1 <= x <= 60
offerId
string

Offer applied from the first added period for its full configured duration. Active subscriptions only; assign an Offer to a pending-payment subscription with PUT /subscriptions/{id}/offer.

Minimum string length: 1
successUrl
string<uri>

Response

Success

checkoutUrl
string
required
object
string
required
Allowed value: "checkout_session"
livemode
boolean
required