Subscriptions
An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.
The ID of the store to retrieve subscriptions for.
411486491630370816411486491630370816411486491630370816411486491630370816411486491630370816411486491630370816The maximum number of items to return in a single request.
Returns items after the specified ID. Used for forward pagination through results.
411486491630370816Returns items before the specified ID. Used for backward pagination through results.
411486491630370816Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.
OK
Data transfer object representing a store subscription.
411486491630370816Human-readable identifier for the subscription.
411486491630370816411486491630370816Represents the current state of a subscription.
411486491630370816Date when a repeating coupon ends for this subscription.
411486491630370816411486491630370816411486491630370816Name used for billing purposes.
Email used for billing purposes.
Country code used for billing purposes.
IP address of the customer at the time of subscription.
Indicates whether this subscription is a gift.
411486491630370816411486491630370816Name of the product associated with this subscription.
URL for the product image.
Numeric value of the billing interval.
Currency code used for billing this subscription.
Indicates whether tax is included in the base price itself.
Base price of the subscription in smallest currency units (e.g., cents).
Formatted string representation of the price.
Amount of discount applied in smallest currency units.
Formatted string representation of the discount amount.
Subtotal amount in smallest currency units.
Formatted string representation of the subtotal amount.
Tax amount in smallest currency units.
Formatted string representation of the tax amount.
Total amount in smallest currency units.
Formatted string representation of the total amount.
Initial discount amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial discount amount.
Initial subtotal amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial subtotal amount.
Initial gift card usage amount in smallest currency units.
Formatted string representation of the initial gift card usage amount.
Initial tax amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial tax amount.
Initial total amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial total amount.
Presentment currency code (currency shown to customer).
Presentment subtotal amount in smallest currency units.
Formatted string representation of the presentment subtotal amount.
Presentment discount amount in smallest currency units.
Formatted string representation of the presentment discount amount.
Presentment tax amount in smallest currency units.
Formatted string representation of the presentment tax amount.
Presentment total amount in smallest currency units.
Formatted string representation of the presentment total amount.
Initial presentment discount amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial presentment discount amount.
Initial presentment subtotal amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial presentment subtotal amount.
Initial presentment gift card usage amount in smallest currency units.
Formatted string representation of the initial presentment gift card usage amount.
Initial presentment tax amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial presentment tax amount.
Initial presentment total amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial presentment total amount.
The foreign exchange rate applied (if presentment currency differs from settlement currency).
Identifier for the pricing region associated with this subscription.
Start date of the current billing period.
End date of the current billing period.
Sequence number of the current billing cycle.
Date and time when the next payment attempt will occur.
Number of payment attempts made for the current billing cycle.
Date and time when the subscription was created.
Date and time when the subscription was last updated.
Date and time when the subscription became active.
Date and time when the subscription was canceled.
Reason provided for cancellation.
Error response
An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.
The ID of the store to retrieve the subscription for.
411486491630370816The ID of the subscription.
411486491630370816OK
Data transfer object representing a store subscription.
411486491630370816Human-readable identifier for the subscription.
411486491630370816411486491630370816Represents the current state of a subscription.
411486491630370816Date when a repeating coupon ends for this subscription.
411486491630370816411486491630370816411486491630370816Name used for billing purposes.
Email used for billing purposes.
Country code used for billing purposes.
IP address of the customer at the time of subscription.
Indicates whether this subscription is a gift.
411486491630370816411486491630370816Name of the product associated with this subscription.
URL for the product image.
Numeric value of the billing interval.
Currency code used for billing this subscription.
Indicates whether tax is included in the base price itself.
Base price of the subscription in smallest currency units (e.g., cents).
Formatted string representation of the price.
Amount of discount applied in smallest currency units.
Formatted string representation of the discount amount.
Subtotal amount in smallest currency units.
Formatted string representation of the subtotal amount.
Tax amount in smallest currency units.
Formatted string representation of the tax amount.
Total amount in smallest currency units.
Formatted string representation of the total amount.
Initial discount amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial discount amount.
Initial subtotal amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial subtotal amount.
Initial gift card usage amount in smallest currency units.
Formatted string representation of the initial gift card usage amount.
Initial tax amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial tax amount.
Initial total amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial total amount.
Presentment currency code (currency shown to customer).
Presentment subtotal amount in smallest currency units.
Formatted string representation of the presentment subtotal amount.
Presentment discount amount in smallest currency units.
Formatted string representation of the presentment discount amount.
Presentment tax amount in smallest currency units.
Formatted string representation of the presentment tax amount.
Presentment total amount in smallest currency units.
Formatted string representation of the presentment total amount.
Initial presentment discount amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial presentment discount amount.
Initial presentment subtotal amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial presentment subtotal amount.
Initial presentment gift card usage amount in smallest currency units.
Formatted string representation of the initial presentment gift card usage amount.
Initial presentment tax amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial presentment tax amount.
Initial presentment total amount in smallest currency units for the first billing cycle.
Formatted string representation of the initial presentment total amount.
The foreign exchange rate applied (if presentment currency differs from settlement currency).
Identifier for the pricing region associated with this subscription.
Start date of the current billing period.
End date of the current billing period.
Sequence number of the current billing cycle.
Date and time when the next payment attempt will occur.
Number of payment attempts made for the current billing cycle.
Date and time when the subscription was created.
Date and time when the subscription was last updated.
Date and time when the subscription became active.
Date and time when the subscription was canceled.
Reason provided for cancellation.
Error response
An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.
The ID of the store to cancel the subscription for.
411486491630370816The ID of the subscription.
411486491630370816No Content
Error response
No content
Last updated
Was this helpful?