Authorizations
Enter your API key in the format x-api-key <api-key>*
Path Parameters
Subscription ID
Body
Activate Draft Subscription Request
start_date is the new start date for the subscription when activating
Response
OK
ActivePauseID references the current active pause configuration This will be null if no pause is active or scheduled
BillingAnchor is the reference point that aligns future billing cycle dates. It sets the day of week for week intervals, the day of month for month and year intervals, and the month of year for year intervals. The timestamp is in UTC format.
RECURRING, ONETIME anniversary, calendar MONTHLY, ANNUAL, WEEKLY, DAILY, QUARTERLY, HALF_YEARLY BillingPeriodCount is the total number units of the billing period.
CancelAt is the date the subscription will be canceled
CancelAtPeriodEnd is whether the subscription was canceled at the end of the current period
CanceledAt is the date the subscription was canceled
CollectionMethod determines how invoices are collected
CommitmentAmount is the minimum amount a customer commits to paying for a billing period
CouponAssociations are the coupon associations for this subscription
Credit grants are the credit grants for this subscription
Currency is the currency of the subscription in lowercase 3 digit ISO codes
CurrentPeriodEnd is the end of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
CurrentPeriodStart is the end of the current period that the subscription has been invoiced for. At the end of this period, a new invoice will be created.
Customer response object containing all customer information
CustomerID is the identifier for the customer in our system
EndDate is the end date of the subscription
EnvironmentID is the environment identifier for the subscription
GatewayPaymentMethodID is the gateway payment method ID for this subscription
ID is the unique identifier for the subscription
InvoicingCustomerID is the customer ID to use for invoicing This can differ from the subscription customer (e.g., parent company invoicing for child company)
LookupKey is the key used to lookup the subscription in our system
OverageFactor is a multiplier applied to usage beyond the commitment amount
none, active, scheduled, completed, cancelled PaymentBehavior determines how subscription payments are handled
Phases are the subscription phases for this subscription
PlanID is the identifier for the plan in our system
create_prorations, none StartDate is the start date of the subscription
published, deleted, archived active, paused, cancelled, incomplete, incomplete_expired, past_due, trialing, unpaid, draft TrialEnd is the end date of the trial period
TrialStart is the start date of the trial period
Version is used for optimistic locking

