What it does
This bulk operation allows you to create up to 5000 subscriptions in status Draft under the selected customers in your Stax Bill account.
Starting Data File
The Bulk Subscription Create lets you download a CSV starting structure.
Fields Supported
The Bulk Subscription Create allows you to identify the target customer, identify the desired plan frequency to use in setting up a subscription and the ability to set high-level subscription labels on the customer.
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 field lengths of data types)
FieldSet Definitions
|
Field name |
Description/Value |
|
|
You must enter at least one field to identify the customer to create the subscription. |
||
|
StaxBillId |
Stax Bill Id |
At least one field is required.
|
|
Reference |
Customer ID (Maximum length of 255 characters) |
|
|
CompanyName |
Company name (Maximum length of 255 characters) |
|
|
PrimaryEmail |
Primary email address (Comma or semicolon-separated, maximum length of 255 characters) |
|
|
Subscription information |
|
|
|
PlanCode |
Plan Code (maximum length of 255 characters) |
Required |
|
NumberOfIntervals |
Number Of Intervals (An integer. Combined with the Frequency Interval to determine subscription recurrence) |
Required |
|
Interval |
Frequency Interval (Monthly or Yearly) |
Required |
|
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) |
|
|
ContractStartDate |
Contract Start Date (Assign a start date to the subscription for reporting.) |
|
|
ContractEndDate |
Contract End Date (Assign end date to the subscription for reporting) |
|
|
ScheduledActivationTimestamp |
Scheduled Activation Timestamp (Configure when this subscription will activate; will still need to be provisioned.) |
|
|
ExpiryPeriods |
Number of remaining intervals (Control whether this subscription will expire.) |
|
| BillingPeriodDefinitionId |
A unique ID that sets the billing period. This can be located on the Invoice section under the Customer Overview page. |
|
| InvoiceOwner |
InvoiceThisCustomer/ InvoiceParent Note: Customer hierarchy must be enabled; otherwise, this field will not be included in the file. |
Required if hierarchy and invoice rollup are set to on. |
Restrictions
- Maximum of 5000 subscription creations per batch.
- Minimum of 1 identifying field (Stax Bill ID, Reference, Company name, Email Address).
- Minimum of Plan frequency identification.
- 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.