menu
close

#Offers

This part of the API allows you to retrieve all the information related to your subscription offers.

#List offers

  • Route: /offers
  • Method: GET
List all of your offers.
Parameters
page
Type: Number
Default: 1
Current page
count
Type: Number
Default: 10
Result number
include
Type: Array
Default: []
Included slugs
exclude
Type: Array
Default: []
Excluded slugs
status
Type: String
Default: active
Offer status

#Get an offer

  • Route: /offers/:id
  • Method: GET
Parameters
id
Type: String
Required
Offer ID or slug
subscriptionCountry
Type: String
Subscription country in ISO 3166-1 alpha-2 format. Enables you to retrieve pricing information for the currency for an advanced offer
countryState
Type: String
Subscription's state (if subscription_country is set to `US` or `CA`) in ISO 3166-1 alpha-2 format. Enables you to specify the state in which the subscription is subscribed.
arrow_forward
NextCustomers