Activate Customer's Specific Subscriptions and Purchases

post

https://secure.fusebill.com/v1/customers/purchase/{CustomerID}

This call is used to activate/finalize draft subscriptions/purchases on a customer who is already in status 'Active'. This can be used to activate/finalize all of their draft subscriptions/purchases, or a subset of their draft subscriptions/purchases

🚧
Providing no JSON body
This call can be made with no JSON body. Doing this has the effect of activating all the draft subscriptions on the customer, and finalizing all the draft purchases on the customer. Providing the specificPurchaseIds or specificSubscriptionIds tells Stax Bill to activate/finalize a subset of the customer's draft subscriptions/purchases.
Note: If a customer has draft purchases and draft subscriptions and you wish to activate only purchases, you will need to send an empty [] specificSubscriptionIds. Failing to include the empty list will cause all specificSubscriptionIds to activate as well.

Path Params

CustomerID

int32

required

The Stax Bill generated ID that uniquely identifies the customer.

Body Params

preview

boolean

Return expected results instead of processing activation.

temporarilyDisableAutoPost

boolean

Bypass customer or account setting to auto post. Instead of an invoice, it will produce a draftinvoice with status ready.

invoiceCollectOptions

object

Used to set collection options for the resulting invoice. Especially important to consider rollbackOnFailedPayment as it can make workflows a lot easier for services that are pay-for-access.

specificSubscriptionIds

array of int32s

List of subscription id's to activate as part of action.

specificSubscriptionIds

specificPurchaseIds

array of int32s

List of purchase id's to activate as part of action.

specificPurchaseIds

Responses

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

Providing no JSON body

200200

400400