Skip to main content
POST
Start a subscription

Authorizations

X-Suby-Api-Key
string
header
required

Secret API key. sk_live_… (production) or sk_sandbox_… (sandbox).

Body

application/json
productId
string
required
Example:

"pro_abc123"

method
enum<string>
required
Available options:
CARD,
APPLE_PAY,
GOOGLE_PAY,
CRYPTO
customerId
string

Mutually exclusive with customerData.

Example:

"cus_abc123"

customerData
object

Inline customer for create-on-the-fly. Mutually exclusive with customerId.

taxBehavior
enum<string>

MoR VAT for the recurring price (applies to every cycle). exclusive (default) adds VAT on top; inclusive treats the price as VAT-inclusive.

Available options:
inclusive,
exclusive
billingAddress
object
businessData
object

B2B purchase (Merchant-of-Record modes only). Drives the VAT reverse-charge (0% VAT except France) and is stored on the customer. businessName doubles as the card holder name.

card
object

Card options. Required for the card family; omit for CRYPTO.

crypto
object

Crypto first-cycle routing. Required when method=CRYPTO; omit for the card family.

successUrl
string<uri>
cancelUrl
string<uri>
metadata
object

Key-value pairs. ≤50 keys, keys ≤40 chars, values are strings ≤500 chars (or null to clear). Nested structures must be JSON-stringified into a single string value.

Response

Subscription started

success
boolean
required
Example:

true

data
object
required

Endpoint-specific payload.

message
string