API Reference
Overview
Quick Start
API Authentication
API Error Codes
APIs
Checkout API
Checkout API
Order Details
User History
Prices
Product API
Product API
Coupons
Products
Licenses
Pay Links
Transactions
Payments
Subscription API
Subscription API
Plans
Users
Modifiers
Payments
One-off Charges
Alert API
Alert API
Webhooks

API Error Codes


Unsuccessful calls return a 200 response with a field called success as false and an error object.

CodeMessage
100Unable to find requested license
101Bad method call
102Bad api key
103Timestamp is too old or not valid
104License code has already been utilized
105License code is not active
106Unable to find requested activation
107You don’t have permission to access this resource
108Unable to find requested product
109Provided currency is not valid
110Unable to find requested purchase
111Invalid authentication token
112Invalid verification token
113Invalid padding on decrypted string
114Invalid or duplicated affiliate
115Invalid or missing affiliate commission
116One or more required arguments are missing
117Provided expiration time is incorrect
118Price is too low
119Unable to find requested subscription
120Request failed due to internal error
121Unable to find requested payment
122Provided date is not valid
123Unable to find requested modifier
124Modifiers that have already been paid cannot be altered or deleted
125Main currency price was not provided
126A valid email address is required, please try again
127The given coupon type is not recognised. The only valid types are flat and percentage.
128The given percentage is not valid. The percentage must be a number less than 100.
129The given amount is not a valid flat amount. The amount must be a number equal to or greater than 0.01.
130The allowed uses must be a number.
131The given coupon code is invalid. The code must have at least 5 characters.
132The given coupon code has already been used for the product.
133The given coupon expiration date is invalid. The expected date format is “Y-m-d”.
134The given coupon currency is invalid. The currency must be one of the currencies of your product.
135Unable to find requested coupon
136Allowed uses cannot be less than times used.
137The allowed uses must be a number greater than or equal to 0.
138The expires at value must be either not provided or a future date in the format of Y-m-d.
139The given prices format is not valid. The prices must have the format of [‘currency:amount’, ‘currency:amount’, …].
140The given currency code is unknown to our checkout system.
141Either a product ID or a plan ID should be given, not both.
142The given recurring prices format is not valid. The recurring prices must have the format of [‘currency:amount’, ‘currency:amount’, …].
143Recurring price is too low
144Affiliate split sum must total less than 100%
145Recurring affiliate split must either be not set, or set to an integer equal to or greater than 1.
146The current invoice of this subscription is currently being processed, and cannot be updated at this time
147We were unable to complete the resubscription because we could not charge the customer for the resubscription
148The resubscription requires immediate billing so we cannot complete your request
149The plan interval is invalid
150Initial price is too low
151The subscription cannot be updated at this time. Please try later.
152Plan changes can not be made whilst the customer is in their trial period.
153The trial length must be a positive integer.
154Unable to find requested order
155The given amount is not valid.
156The Order cannot be refunded.
157An unknown coupon error has occurred.
158The coupon currency must match your balance currency
159The parameters combination is incorrect.
160Invalid recurring option.
161The minimum threshold must be numeric and higher than 0.01.
162The group has to be a string with at least 1 character and no more than 50 characters.
163The number of coupons is invalid.
164The can_multiple_in_same_checkout parameter has to be a boolean value.
165The given coupon target is not recognised. The only valid types are product and checkout.
166The description has to be a string.
167You cannot set the amount for Flat and Percentage coupons at the same time.
168The product type must be a subscription plan.
170license_code is not set.
171download_url is not set or invalid.
172The transaction can no longer be refunded.
173The subscription does not allow quantities to be set.
174Cannot move to this plan as it doesn't support the subscription currency.
175Invalid country code.
176This order already has a license code attached to it
177product_name is not set.
180download_url is invalid.
181charge_name is too long or invalid. Length limit: 50
182The given subscription ID is invalid. IDs must be numeric.
183Charges cannot be made with a negative amount
184Access Denied.
185Subscription billing cycles exceeded. Subscription expired.
186Amount is less than allowed minimum transaction amount.
187Subscription has been deleted.
188Transaction failed.
189Rate limit reached for this type of request. Please try again later.
190No valid payment method found
191You cannot pass an offset without defining a limit
192No other modifications are allowed when pausing/unpausing a subscription
193You can not pause/unpause this subscription
194Changes can not be made whilst the subscription is paused.
195The given cancellation reason is not valid.
196Subscription is in a past_due state and the plan can therefore not be changed.
197The subscription of the customer is not active.
198The selected new plan is invalid.
199No other modifications except pausing and changing the passthrough are allowed on a past due subscription.
205Seller statement descriptor is already in use by another seller, please choose a different one
206Charges cannot be made whilst the subscription is paused
207The given postcode is invalid