List subscriptions

get

http://localhost:3009/api/public/v1/subscriptions

Retrieve a list of subscriptions with optional filtering

Query Params

status

string

enum

Filter by subscription status

payment_status

string

enum

Filter by payment status

Allowed:

string

Search by customer name, phone, or reference

created_at

string

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_at

string

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_reference

string

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

store_reference

string

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

merchant_id

string

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

store_id

string

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

Headers

Authorization

string

required

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Basic

base64

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

text/html

200Successful

401Unauthorized