Sign in

v1

latestOpenAPI 3.0.32026-07-1336286494.8 KB
api

get/api/subscriptions/

Query parameters

customer_idstring nullable required

Filter to a specific customer.

plan_idstring uuid

Filter to a specific plan.

range_endstring date-time

If specified, will only return subscriptions with a start date before this date.

range_startstring date-time

If specified, will only return subscriptions with an end date after this date.

statusstring[]

Filter to a specific set of subscription statuses. Defaults to active.

valuestring required
property_namestring required

The string name of the property to filter on. Example: 'product_id'

Filter to a specific set of subscription filters. If your billing model only allows for one subscription per customer, you very likely do not need this field. Must be formatted as a JSON-encoded + stringified list of dictionaries, where each dictionary has a key of 'property_name' and a key of 'value'.

Response

subscription_idstring required
start_datestring date-time required

The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.

end_datestring date-time required

The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time.

auto_renewboolean required

Whether the subscription automatically renews. Defaults to true.

is_newboolean required

Whether this subscription came from a renewal or from a first-time. Defaults to true on creation.

fully_billedboolean required
metadataobject required