Subscriptions

Get subscriptions

get

Retrieves all subscriptions for the specified store.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequired

The ID of the store to retrieve subscriptions for.

Example: 411486491630370816
Query parameters
customer_idstring · flake-idOptionalExample: 411486491630370816
subscription_idstring · flake-idOptionalExample: 411486491630370816
billing_emailstringOptional
payment_method_idstring · flake-idOptionalExample: 411486491630370816
checkout_idstring · flake-idOptionalExample: 411486491630370816
trial_idstring · flake-idOptionalExample: 411486491630370816
limitinteger · int32 · min: 1 · max: 100Optional

The maximum number of items to return in a single request.

afterstring · flake-idOptional

Returns items after the specified ID. Used for forward pagination through results.

Example: 411486491630370816
beforestring · flake-idOptional

Returns items before the specified ID. Used for backward pagination through results.

Example: 411486491630370816
ascbooleanOptional

Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.

Responses
200

OK

application/json
get
/v1/stores/{storeId}/subscriptions

Get subscription by ID

get

Retrieves a subscription for the specified store by the supplied ID.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequired

The ID of the store to retrieve the subscription for.

Example: 411486491630370816
subscriptionIdstring · flake-idRequired

The ID of the subscription.

Example: 411486491630370816
Responses
200

OK

application/json
get
/v1/stores/{storeId}/subscriptions/{subscriptionId}

Cancel subscription by ID

post

Cancels a subscription for the specified store by the supplied ID.

Authorizations
AuthorizationstringRequired

An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.

Path parameters
storeIdstring · flake-idRequired

The ID of the store to cancel the subscription for.

Example: 411486491630370816
subscriptionIdstring · flake-idRequired

The ID of the subscription.

Example: 411486491630370816
Responses
post
/v1/stores/{storeId}/subscriptions/{subscriptionId}/cancel

No content

Last updated

Was this helpful?