Authorizations
API key for authentication
Path Parameters
Response
Subscription estimate serializer from OrderPricing
End date of subscription
Subtotal before taxes and discounts
Final total after taxes and discounts
The line items of the subscription
The billing schedule of the subscription
Breakdown containing total discount and tax amounts
Unique identifier for the subscription
Customer details Customer output serializer; we can represent the customer model differently depending on the request so we need a custom serializer for the output.
Date of renewal
Current status of the subscription
ACTIVE
- ActiveORDER_NEEDED
- Order neededOPEN_ORDER
- Open orderSCHEDULED
- ScheduledTERMINATED
- TerminatedTERMINATING
- TerminatingINACTIVE
- Inactive
ACTIVE
, ORDER_NEEDED
, OPEN_ORDER
, SCHEDULED
, TERMINATED
, TERMINATING
, INACTIVE
Current stage of the subscription
BUILDING
- OpenCLOSED
- Closed WonCLOSED_LOST
- Closed LostCLOSED_DELETE
- Closed DeleteSELLER_SIGNING
- SigningMIGRATING
- Migrating
BUILDING
, CLOSED
, CLOSED_LOST
, CLOSED_DELETE
, SELLER_SIGNING
, MIGRATING
Date of termination
Start date of subscription
Billing frequency of the subscription
MONTHLY
- MonthlyQUARTERLY
- QuarterlySEMI_ANNUALLY
- Semi-annuallyANNUALLY
- AnnuallyALL_UPFRONT
- All upfront
MONTHLY
, QUARTERLY
, SEMI_ANNUALLY
, ANNUALLY
, ALL_UPFRONT
Primary contact person for the subscription
User who signed the subscription agreement
List of email addresses for accounts payable contacts
The currency used
USD
- United States DollarEUR
- EurosGBP
- Great British PoundAUD
- Australian DollarCAD
- Canadian Dollar
USD
, EUR
, GBP
, AUD
, CAD
Optional metadata to add to the subscription.