This is a bulk action that will make a large number of changes that can not be undone.
Use a small sample (1-5 entries) to check the changes work as expected.
What it does
This bulk operation allows you to cancel up to 1000 subscriptions under various customers in your Stax Bill account
Starting Data File
The Bulk Subscription Cancel allows you to download a starting structure in CSV format.
Fields Supported
The Bulk Subscription Cancel allows you to identify the target subscriptions by ID, Name, Description or Reference and specify a Cancellation Option.
Validation
When your CSV is ready for uploading the data will be validated for proper structure and field by field validation for data errors (such as invalid unique subscription identification)
FieldSet Definitions
|
SubscriptionId |
The unique Stax Bill Id of the subscription |
|
SubscriptionName |
Subscription Name (Maximum length of 100 characters. Overrides the Plan Name) |
|
SubscriptionDescription |
Subscription Description (Maximum length of 500 characters. Overrides the Plan Description) |
|
SubscriptionReference |
Subscription Reference (Maximum length of 255 characters) |
|
Cancellation Option |
Controls the type of charge reversal to implement for the cancellation. Must be a string of None, Unearned, Full "None" will have no reversal take place, and the system will fully earn the charges from the current period as though services provided have completed and been provided fully. "Unearned" will reverse the unearned deferred revenue of the current period's charges. This is typically a partial reversal based on daily or monthly earning rules set on the Plan product at the time the subscription was created. "Full" will reverse all charges for the current period, regardless of how much has been earned. |
Restrictions
- Maximum of 1000 subscription cancellations per batch.
- Minimum of 1 identifying field (Subscription ID, Subscription Name, Description, Reference).
- Cancellation Option Field (None, Unearned, Full).
- Webhooks are not generated for records processed by a bulk job.
- Calls to 3rd Party tools (Salesforce / QuickBooks / NetSuite) are not sent for records processed by bulk jobs.