List plans
Lists all available subscription plans for a shop. By default returns only active plans. Use the status filter to include archived or deprecated plans.
Query Parameters
Filter by status: "active", "archived", "deprecated" (defaults to active only)
Response Body
application/json
application/json
curl -X GET "https://example.com/sdk/plans"{ "plans": [ { "id": "string", "segmentId": "string", "code": "string", "name": "string", "description": "string", "billingPeriodValue": "string", "billingPeriodUnit": "string", "prices": [ { "currency": "string", "amountCents": "string" } ], "trialPeriodValue": "string", "trialPeriodUnit": "string", "benefitsJson": "string", "status": "string", "availableFrom": "2019-08-24T14:15:22Z", "availableUntil": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ]}How is this guide?
Get plan by code GET
Retrieves a subscription plan by its code (e.g., 'monthly_premium'). Plan codes are unique within a segment.
Cancel subscription POST
Cancels a subscription. By default, access continues until the end of the current billing period (cancel_at_period_end=true). A subscription.canceled webhook is sent and the returned subscription has status 'canceled'. For past_due subscriptions, cancellation is immediate: a single subscription.expired webhook is sent and the returned subscription has status 'expired'.