Retrieve a subscription
Returns the current subscription details for the specified ID, including plan name, lifecycle dates, billing information, point of contact, and line items. Use this endpoint to show subscription lifecycle info in user dashboards (e.g., start/end dates, contract renewal dates) and track active plan details.
Documentation Index
Fetch the complete documentation index at: https://docs.salesbricks.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
API key for authentication
Path Parameters
^([a-zA-Z\d\-]+)$Response
Subscription detail serializer.
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
Date of renewal
Current status of the subscription
ACTIVE- ActiveORDER_NEEDED- Order neededOPEN_ORDER- Open orderSCHEDULED- ScheduledTERMINATED- TerminatedTERMINATING- TerminatingINACTIVE- InactivePAUSED- PausedSUPERSEDED- Superseded
ACTIVE, ORDER_NEEDED, OPEN_ORDER, SCHEDULED, TERMINATED, TERMINATING, INACTIVE, PAUSED, SUPERSEDED 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 The medium by which the order is agreed.
ORDER_FORM- Order formSTRIPE- Stripe
ORDER_FORM, STRIPE Date of termination
Subscription time zone
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
Product details
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 DollarINR- Indian Rupee
USD, EUR, GBP, AUD, CAD, INR The payment terms for this susbcription
If the subscription will auto renew at the end of the current contract period
Optional metadata to add to the subscription.