Subscriptions
Retrieve subscription details
Fetches detailed information about a specific subscription. Includes product and variant details associated with the subscription.
Business Use-case: Useful for understanding customer subscriptions and managing their lifecycle.
Path Parameters:
id: Subscription ID (path parameter, required).
Responses:
200: Subscription details retrieved successfully.401: Unauthorized ifx-store-idis missing.404: Not Found if the subscription does not exist.
GET
Retrieve subscription details
Previous
Update subscription statusUpdates the status of a subscription, allowing actions such as cancelation, immediate cancelation, or resumption.
**Business Use-case:** Useful for managing the lifecycle of subscriptions, including cancelation and resumption.
**Path Parameters:**
- `id`: Subscription ID (path parameter, required).
**Request Body:**
- `action`: The action to perform on the subscription (required: `cancel`, `cancel_immediately`, or `resume`).
**Responses:**
- `200`: Subscription updated successfully.
- `400`: Bad request if action is invalid.
- `401`: Unauthorized if `x-store-id` is missing.
- `404`: Not Found if the subscription does not exist.
Next
Retrieve subscription details