Sign in
api

A simple ViewSet for viewing and editing Subscriptions.

get/api/subscriptions/

Query parameters

customer_idstring 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.

Response

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

Whether the subscription has been fully billed and finalized.

Changes