v1

latestOpenAPI 3.1.02026-07-245644294.6 KB

Subscriptions

List subscriptions

Retrieve a list of subscriptions with optional filtering

get/api/public/v1/subscriptions

Example:active

Filter by subscription status

payment_status'paid' | 'unpaid'

Example:unpaid

Filter by payment status

qstring

Example:John Doe

Search by customer name, phone, or reference

created_atstring

Example:2024-01-15

Filter by creation date. Supports multiple formats:

Single date: YYYY-MM-DD (e.g., '2024-01-15')

Predefined periods: 'current_month', 'current_year'

Date range: Use nested parameters created_at[from]=2024-01-01&created_at[to]=2024-01-31

activated_atstring

Example:2024-02-01

Filter by activation date. Supports multiple formats:

Single date: YYYY-MM-DD (e.g., '2024-01-15')

Predefined periods: 'current_month', 'current_year'

Date range: Use nested parameters activated_at[from]=2024-01-01&activated_at[to]=2024-01-31

merchant_referencestring

Example:MERCHANT_001

Filter by merchant reference (comma-separated for multiple). Available merchants are restricted to the API account's configured access.

store_referencestring

Example:STORE_001

Filter by store reference (comma-separated for multiple). Available stores are restricted to the API account's configured access.

merchant_idstring

Example:123,456

Filter by merchant ID (comma-separated for multiple). Available merchants are restricted to the API token's configured access.

store_idstring

Example:789,101

Filter by store ID (comma-separated for multiple). Available stores are restricted to the API token's configured access.

Authorizationstring required

Successful