v1

latestOpenAPI 3.1.02026-07-26580123.9 KB

Customer subscriptions

This query gets individual customer's subscriptions using the unique identifier provided in the Billsby platform

get/{companyDomain}/customers/{customerUniqueId}/subscriptions

Path parameters

companyDomainstring required

Your companies Billsby subdomain - for example, if you login at widgets.billsby.com, your companyDomain is widgets

customerUniqueIdstring required

The unique identifier of the customer in the Billsby platform

Response

200

subscriptionIdstring

productIdinteger

productNamestring

planIdinteger

planNamestring

statusstring

currencystring

revenuestring

nextBillingstring

createdOnstring

unitsinteger

Example response

[
  {
    "subscriptionId": "string",
    "productName": "string",
    "planName": "string",
    "status": "string",
    "currency": "string",
    "revenue": "string",
    "nextBilling": "2020-04-29T10:46:39.498Z",
    "createdOn": "2020-04-29T10:46:39.498Z"
  }
]