POST
/
billing-groups

Authorizations

Authorization
string
headerrequired

Value for the Authorization header parameter.

Body

customer
string
required

The customer of the billing group.

name
string
required

The name of the billing group.

Maximum length: 255
type
enum<string>
required

The type of the billing group.

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".

Required range: 0 < x < 31
customMonth
integer | null
required

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

Required range: 0 < x < 12

Response

201 - application/json
name
string
required

The name of the billing group.

Maximum length: 255
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".

Required range: 0 < x < 31
customMonth
integer | null
required

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

Required range: 0 < x < 12
id
string

Was this page helpful?

Get a subscription measurementGet a billing group