Activate Subscription

Activates a subscription.

The Subscription Activation call does not require a content body. This action will set the Subscription status to Active, which, in most cases, will generate an invoice and, depending on the customer's billing options, apply a charge and initiate a collection attempt against the Customer's payment method. The Subscription will activate regardless of whether the collection attempt succeeds or fails, so you should review the invoices to ensure payment was successful. This call returns the Subscription you have activated, so you can verify that the status field is set to Active. This action can only be performed on Subscriptions with a status of Draft or Provisioning. In Stax Bill, each Subscription is attached to a Billing Period, which defines the start and end of the billing cycle and the duration (e.g., one month, starting on the 1st of January, or 1 Year, starting on the 4th of May). Stax Bill allows a Customer to have multiple Billing Periods, meaning different Subscriptions can have different start and end dates (e.g., one Subscription starting on the 4th of the month, another on the 9th, etc.). You can define the Billing Period that the Subscription should align to when you perform this call by passing in the appropriate fields in the call body.

Request Examples

Path Params
int32
required

ID of the subscription to be activated.

Query Params
string

If the Preview url parameter is set to True the subscription is not activated, the call will simple simulate the activation and calculate the mock invoice

string

If set to true, zero dollar charges will be included on invoices.

string

This will specify whether or not the resulting invoice from this call will post the related invoice or not

string
enum

If the value "sideeffects" is used, the response will include any resulting invoice information.

Allowed:
Body Params
int32

Tells the system to create a billing period that cycles on the specified month and assigns this subscription to it. Typically only used for yearly frequencies. If this parameter is used for a monthly frequency, Fusebill will adjust the billing period such that the subscription will recharge on the provided day and month.

int32

Tells the system to create a billing period that cycles on the specified day.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json