Endpoints
Authorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequirednameRequiredstringMust not be greater than 255 characters.
product_idRequiredintegervariant_idintegerbuy_quantityRequiredintegerMust be at least 1.
discounted_quantityRequiredintegerMust be at least 1.
percentageRequirednumberMust be at least 0.01. Must not be greater than 100.
max_uses_per_cartintegerMust be at least 1.
priorityintegerMust be at least 0.
starts_atstringMust be a valid date. Must be a date before 2038-01-19.
ends_atstringMust be a valid date. Must be a date before 2038-01-19.
enabledRequiredbooleanPath Parameters
shopIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredstringdealIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredstringdealIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequirednameRequiredstringMust not be greater than 255 characters.
product_idRequiredintegervariant_idintegerbuy_quantityRequiredintegerMust be at least 1.
discounted_quantityRequiredintegerMust be at least 1.
percentageRequirednumberMust be at least 0.01. Must not be greater than 100.
max_uses_per_cartintegerMust be at least 1.
priorityintegerMust be at least 0.
starts_atstringMust be a valid date. Must be a date before 2038-01-19.
ends_atstringMust be a valid date. Must be a date before 2038-01-19.
enabledRequiredbooleanPath Parameters
shopIdRequiredstringdealIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequirednameRequiredstringMust not be greater than 255 characters.
typeRequiredstring"percentage" | "fixed"discountRequirednumberMust be at least 0.01. Must not be greater than 999999.
max_uses_per_cartintegerMust be at least 1.
priorityintegerMust be at least 0.
starts_atstringMust be a valid date. Must be a date before 2038-01-19.
ends_atstringMust be a valid date. Must be a date before 2038-01-19.
enabledRequiredbooleanitemsRequiredarray<integer>Must have at least 1 items.
Path Parameters
shopIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredstringofferIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredstringofferIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonRequirednameRequiredstringMust not be greater than 255 characters.
typeRequiredstring"percentage" | "fixed"discountRequirednumberMust be at least 0.01. Must not be greater than 999999.
max_uses_per_cartintegerMust be at least 1.
priorityintegerMust be at least 0.
starts_atstringMust be a valid date. Must be a date before 2038-01-19.
ends_atstringMust be a valid date. Must be a date before 2038-01-19.
enabledRequiredbooleanitemsRequiredarray<integer>Must have at least 1 items.
Path Parameters
shopIdRequiredstringofferIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalpageintegerperPageintegerMust be at least 1. Must not be greater than 100.
typestring"created" | "pending" | "all"searchstringMust not be greater than 255 characters.
date_fromstringMust be a valid date.
date_tostringMust be a valid date. Must be a date after or equal to date_from.
include_dismissedbooleanPath Parameters
shopIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredstringinvoiceIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredstringinvoiceIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalinvoice_idsarray<integer>coupon_idintegerPath Parameters
shopIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalcoupon_idintegerPath Parameters
shopIdRequiredstringinvoiceIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalstatusstring"pending" | "trialing" | "active" | "past_due" | "cancelled" | "expired"product_idintegercustomer_idintegerperPageintegerPath Parameters
shopIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Path Parameters
shopIdRequiredstringsubscriptionIdRequiredstringAuthorization
AuthorizationRequiredBearer <token>You can retrieve your API key by visiting your dashboard and clicking Account > API.
In: header
Request Body
application/jsonOptionalat_period_endbooleanPath Parameters
shopIdRequiredstringsubscriptionIdRequiredstring