API documentation
User
Tenant
Feature
Entitlement
User & permissions
Settings
Payment
Customer
Billing
Dunning
Offers
Catalogue
Checkout
cURL
Copy
curl -X GET \
/customers/{customerId}/billing-groups \
--header "Authorization: Bearer <token>"Copy
{
"data": [
{
"name": "Billing of payments at the end of the month",
"type": "end_of_month",
"id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
"customDay": 31,
"customMonth": 12
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}Billing Group
Get a collection of billing groups
Get a collection of billing groups
GET
/
customers
/
{customerId}
/
billing-groups
cURL
Copy
curl -X GET \
/customers/{customerId}/billing-groups \
--header "Authorization: Bearer <token>"Copy
{
"data": [
{
"name": "Billing of payments at the end of the month",
"type": "end_of_month",
"id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
"customDay": 31,
"customMonth": 12
}
],
"meta": {
"pagination": {
"totalItems": 123,
"itemsPerPage": 123,
"currentPage": 123,
"lastPage": 123,
"pageTotalItems": 123
}
}
}Authorizations
Value for the Authorization header parameter.
Path Parameters
BillingGroup identifier
Query Parameters
The collection page number
The number of items per page
Required range:
0 <= x <= 100Response
BillingGroup collection
Show child attributes
Show child attributes
The name of the billing group.
Maximum string length:
255Example:
"Billing of payments at the end of the month"
The type of the billing group.
Possible values:
start_of_month: The billing group will be charged on the first day of the month.end_of_month: The billing group will be charged on the last day of the month.start_of_year: The billing group will be charged on the first day of the year.end_of_year: The billing group will be charged on the last day of the year.custom: The billing group will be charged on a custom day of the month.
Example:
"end_of_month"
Example:
"01F9ZQZJZJQZJZJZJZJZJZJZJZ"
The custom day of the billing group, only used when type is "custom".
Required range:
x <= 31Example:
31
The custom month of the billing group, only used when type is "custom".
Required range:
x <= 12Example:
12
Was this page helpful?
⌘I