GET
/
billing-groups
/
{id}

Authorizations

Authorization
string
headerrequired

Value for the Authorization header parameter.

Path Parameters

id
string
required

BillingGroup identifier

Response

200 - application/json
id
string
name
string
required

The name of the billing group.

type
enum<string>
required

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.
Available options:
start_of_month,
end_of_month,
start_of_year,
end_of_year,
custom
customDay
integer | null
required

The custom day of the billing group, only used when type is "custom".

customMonth
integer | null
required

The custom month of the billing group, only used when type is "custom".

subscriptions
string[]

The subscriptions which are assigned to the billing group.

Was this page helpful?

Create a billing groupGet a collection of billing groups