Receiving regular Bango Subscriptions API reports
Bango creates daily, weekly, and monthly reports and stores them in your own dedicated Amazon S3 bucket. You can use these reports for reconciliation purposes.
For resellers, reports are grouped by merchant. For merchants, reports are grouped by reseller.
Reports are published within 24 hours of the end of the reporting period.
When you sign up to use the Bango Subscriptions API, Bango Support will supply you with:
Report | Frequency | Description |
---|---|---|
Active subscriptions | Daily, weekly, monthly | All active subscriptions at reporting time |
New subscriptions | Daily, weekly, monthly | Subscriptions created during the reporting period |
Canceled subscriptions | Daily, weekly, monthly | Subscriptions canceled during the reporting period |
Renewed subscriptions | Daily, weekly, monthly | Subscriptions renewed during the reporting period |
All reports use UTC timestamps. Weeks start on Monday.
The "Canceled subscriptions" report contains cancellations that have taken effect, not scheduled future cancellations.
The reports are stored at:
s3://{customer}/SubscriptionReports/{accountKey}/{frequency}/{yyyy}/{mm}/{dd}
Where:
Daily
, Weekly
, or Monthly
Filenames have the format:
{type}_V1_{frequency}_{date}.csv
Where:
AS
for active subscriptionsNS
for new subscriptionsCS
for canceled subscriptionsRS
for renewed subscriptionsM
for monthlyW
for weeklyD
for dailyYYYYMM
, for example 202008
for August 2020YYYYMMDD
, for example 20200817
for August 17, 2020For example:
NS_V1_W_20200810.csv
is the "new subscriptions" report for the week commencing August 10, 2020AS_V1_M_202009.csv
is the "active subscriptions" report for September 2020All report files are Windows-1252 encoded and contain RFC 4180-compliant comma-separated values (CSV).
Column | Type | Description |
---|---|---|
SubscriptionId | String | The globally unique subscription ID |
SubscriptionExternalKey | String | Any customer-specific subscription id supplied |
BangoUserId | Long/String | The unique Bango ID for the user |
MerchantAccountKey | String | The merchant's unique identifier in the Bango Platform |
ProductName | String | The product associated with the subscription |
PlanName | String | The plan associated with the subscription |
PhaseType | TRIAL , DISCOUNT , FIXEDTERM , or EVERGREEN | The current phase type of the subscription |
BillingPeriod | MONTHLY , DAILY ,WEEKLY , BIWEEKLY ,THIRTY_DAYS , SIXTY_DAYS ,NINETY_DAYS , BIMESTRIAL ,QUARTERLY , TRIANNUAL ,BIANNUAL , ANNUAL ,BIENNIAL , or NO_BILLING_PERIOD | The current billing period of the subscription |
State | PENDING , ACTIVE , or CANCELLED | The current state of the subscription |
EntitlementStartDate | YYYY-MM-DD string | UTC date on which the subscription starts or started |
CancelledDate | YYYY-MM-DD string or empty | UTC date on which the subscription was or will be canceled |
ChargedThroughDate | YYYY-MM-DD string | UTC date up to which the subscription has been invoiced |
BillingStartDate | YYYY-MM-DD string | UTC date on which billing starts or started |
BillingEndDate | YYYY-MM-DD string | UTC date on which billing ends or ended |
BillCycleDayLocal | Integer | The default day of the month on which to bill users, for subscriptions where the a billing period is a multiple of one month |
LastPaymentAmount | Float | The amount of the most recent successful payment |
LastPaymentCurrency | ISO 4217 three-letter currency code | The currency of the most recent successful payment |
LastPaymentDate | YYYY-MM-DD string | UTC date of the most recent successful payment |
NextPaymentAmount | Float | The amount of the next payment |
NextPaymentCurrency | ISO 4217 three-letter currency code | The currency of the next payment |
NextPaymentDate | YYYY-MM-DD string | UTC date of the next payment |
ExtensionDataFormat | String | Format of the ExtensionData column |
ExtensionData | XML serialised to string | Any custom data associated with the subscription |