Skip to main content

Subscriptions

Subscription operations are currently exposed primarily through merchant-scoped billing routes.

The Subscription object​

{
  "id": "sub_abc123",
  "object": "subscription",
  "customer": "cus_xyz789",
  "status": "active",
  "items": [
    { "id": "si_abc", "price": "price_premium_monthly", "quantity": 1 }
  ],
  "current_period_start": 1708300800,
  "current_period_end": 1710979200,
  "created": 1708300800
}

Implemented route family​

Current merchant subscription routes include:

  • GET /api/v1/merchant/subscriptions
  • GET /api/v1/merchant/subscriptions/{id}
  • POST /api/v1/merchant/subscriptions
  • POST /api/v1/merchant/subscriptions/{id}/cancel

Legacy-compatible merchant paths may also be available under api/merchant/*.

List subscriptions​

GET /api/v1/merchant/subscriptions
ParameterTypeDescription
pageintegerPage number
limitintegerNumber of results per page
statusstringFilter by status

Create a subscription​

POST /api/v1/merchant/subscriptions

Cancel a subscription​

POST /api/v1/merchant/subscriptions/{id}/cancel

Integration note​

The current docs should treat subscriptions as part of the merchant billing surface unless a separate public subscription controller is explicitly exposed.