Sign in

v1

latestOpenAPI 3.0.32026-07-24614422630.2 KB
Subscriptions

Get subscription details

Gets the details of the specified subscription.

get/subscriptions/{id}

Path parameters

idstring required

subscription id

Response

successful operation

idstring
versioninteger required
entityIdstring required
externalIdstring
accountIdstring required
shippingContactIdstring
billingContactIdstring
state'ACTIVE' | 'EXPIRED' | 'CANCELLED' | 'PENDING' | 'PENDING_CANCELLATION' required
startDateinteger required
endDateinteger required
canceledDateinteger
paymentTermstring
billingTerm'UP_FRONT' | 'IN_ARREARS'
ordersstring[] required
purchaseOrderRequiredForInvoicingboolean
creationTimeinteger required
rampIntervalinteger[]
renewedFromSubscriptionIdstring
renewedFromDateinteger
renewedToSubscriptionIdstring
renewedToDateinteger
restructuredFromSubscriptionIdstring
restructuredFromDateinteger
restructuredToSubscriptionIdstring
restructuredToDateinteger
autoRenewboolean
activationDateinteger
namestring
customFieldsobject