v1

latestOpenAPI 3.0.02026-07-2335196124.2 KB
Subscription

Search subscriptions

get/subscriptions/

Query parameters

CustomerEmailstring

Customer's email

DeliveredCodestring

Customer's delivered code

AvangateCustomerReferencestring

Customer's reference

ExternalCustomerReferencestring

Customer's external reference

Aggregateboolean

Aggregated data, the only valid value is 'true'

SubscriptionEnabledboolean

Checks status

RecurringEnabledboolean

Filter by recurring status

ProductCodesstring[]

Array of product codes

CountryCodesstring[]

Array of countries codes

PurchasedAfterstring

Purchase date

PurchasedBeforestring

Purchase date

ExpireAfterstring

Expire date

ExpireBeforestring

Expire date

RenewedAfterstring

Renew date

RenewedBeforestring

Renew date

NotificationAfterstring

Notification date

NotificationBeforestring

Notification date

ModifiedAfterstring

Change date

ModifiedBeforestring

Change date

NextBillingDateAfterstring

Start date of Next billing date filter

NextBillingDateBeforestring

End date of Next billing date filter

LifetimeSubscriptionboolean

Filter by lifetime subscriptions

Typestring

Subscription types

Pageinteger

Requested page

Limitinteger

Limit number

Headers

Accept'application/json' required
X-Avangate-Authenticationstring required

Authentication header

Response

List subscriptions