This guide walks you through the process of importing usage data for subscription plans tied to usage-based pricing models. Note that usage will fail if the customer, plans, and subscription is not already present in this system. Read about the sequence of imports here.
Sample File:
Take a look at this sample file for the import of Usages.
Step 1: File Preparation
Create a CSV file that contains the following required fields.
Usage | |
Subscription* | The subscription id this usage is attached to. |
Charge* | The charge ID (usage-based) that this usage is attached to. |
Customer* | A unique identifier tying a subscription to a specific customer. |
Start Date* | Usage is tracked for a period that starts at this date. |
End Date* | Usage is tracked for a period that ends at this date. |
Quantity* | A numeric value quantifying usage based on the criterion defined by the plan this subscription is tied to. |
Step 2: File Upload
- Go to the ‘Usage’ module. If it is not visible simply click the gearbox next to Dashboard and shift it from unselected to selected to make it visible.
- Browse a CSV carrying usage data.
- Here is some sample usage data.
- Upload the file and click ‘Next’.
Step 3: Field Mapping
- The box on the right shows the fields required for mapping a successful import.
- Set the date format and choose advanced settings. Click ‘Next’. To learn more about these settings go to this import guide.
- In the event of a successful import, navigate to the usages module to see your new usage from import.
- Go to Subscriptions to locate the one with the usage just uploaded. Click on the customer this subscription is tied to.
- Scroll down and configure your tabs.
- Enable usages to be visible.
- The newly imported usage will be visible in this list with a pending status.
Step 4: Trouble Shooting
- Once the import is completed, scroll to the right to find if records were successfully imported or updated or failed. Download the errors file to find the cause of record import failure.
That is how you import usage. The next time this customer is scheduled to be billed, if the period defined within the usage corresponds to this billing period the system will add these usage-based charged to their invoice.
Comments
0 comments
Please sign in to leave a comment.