Skip to main content
POST
Create subscription
This reference describes API version 2026-06-23. Send Commet-Version: 2026-06-23 with your request.

Authorizations

x-api-key
string
header
required

Headers

Commet-Version
string
default:2026-06-23

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

Body

application/json
customerId
string
required
Required string length: 1 - 200
skipTrial
boolean
default:false
required
planId
string
Minimum string length: 1
planCode
string
billingInterval
enum<string> | null
Available options:
weekly,
monthly,
quarterly,
semiannual,
yearly,
one_time
initialSeats
object
customTrialDays
integer
Required range: 0 <= x <= 9007199254740991
introOffer
object
promoCode
string
Minimum string length: 1
provider

Payment provider name or exact public payment connection ID for the initial checkout. Overrides country routing when present.

Available options:
stripe,
commet,
dlocal
paymentMethodTypes
enum<string>[]

Payment methods the initial checkout may offer. Restricts what the checkout already offers for the buyer's country, currency and payment connection; it never enables a method the connection does not have and never changes routing. When none of them is available to the buyer, the checkout shows that it cannot accept payments.

Minimum array length: 1
Available options:
card,
oxxo,
mercado_pago,
google_pay,
smartpix
name
string
startDate
string<date-time>
successUrl
string<uri>
prepaidPeriods
integer

Billing periods of the subscription's interval paid with the first payment, including the current one. Defaults to 1. The interval does not change: each paid period renews at zero and the subscription renews normally after the last one unless cancelAtPeriodEnd is true.

Required range: 1 <= x <= 60
cancelAtPeriodEnd
boolean

Schedules the cancellation from creation so the subscription ends after its last paid period and never renews with any payment method.

Response

Success

success
any
required
data
object
required