v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

List subscriptions

This endpoint returns subscriptions that match the specified criteria (transactionId, paymentMethodId, externalId, customerId or offerId and customerId together). Please bear in mind that if you don't provide any parameters, an empty list will be returned. <br><br> Note: Filtering by customerId and offerId might return multiple active subscriptions instead of one if multiple subscriptions have been created for the same offer.

get/subscriptions

Query parameters

customerIdinteger

Customer identifier at Cleeng.

externalIdstring

The external identifier of a subscription.

limitinteger

Defines the number of results in each API response. Default is 20, allowed values 1-100.

offerIdstring

The identifier of Cleeng offer. If you want to use this parameter for search, you have to provide customerId, too.

offsetinteger

From which element you want to get results - defines the number of first results that are skipped.

paymentMethodIdinteger

The identifier of the payment method, provided by Cleeng.

status[]string[]

Filters response by subscription status. Allowed values: active, stopped, terminated. Multiple values may be used. <br> Example: <br> /3.1/subscriptions?status[]=active&status[]=stopped <br> /3.1/subscriptions?status[]=active

transactionIdstring

A unique identifier of a transaction (e.g. T123456789).

Headers

Content-Typestring

Response

200