Subscriptions/createSubscription

Create a subscription

Planned

Planned. This contract is published ahead of the build. It is not callable yet — treat it as the shape to design against, not a live endpoint.

Bill a saved payment method on a recurring schedule.

POST/v1/subscriptions

Start recurring billing for a customer against a price, charging a saved payment method each period. The first invoice is raised immediately unless a trial is set.

Request body

application/json

customerIdstringRequired

Example "cus_123"

priceIdstringRequired

Example "price_pro_monthly"

paymentMethodIdstringRequired

Example "pm_9c2a4f10"

trialDaysintegernullable

Example 14

Response

application/json

idstring

Example "sub_9c2a4f10"

customerIdstring

Example "cus_123"

priceIdstring

Example "price_pro_monthly"

statusenum

trialingactivepast_duecanceled

Example "active"

currentPeriodEndstring · ISO 8601

Example "2026-04-09T09:14:22Z"

cancelAtPeriodEndboolean

Example false

createdAtstring · ISO 8601

Example "2026-04-09T09:14:22Z"

createSubscription