GET
/
billing-groups
/
{id}
cURL
curl -X GET \
 /billing-groups/{id} \
 --header "Authorization: Bearer <token>"
{
  "id": "01F9ZQZJZJQZJZJZJZJZJZJZJZ",
  "name": "Billing of payments at the end of the month",
  "type": "<any>",
  "customDay": 31,
  "customMonth": 12,
  "subscriptions": [
    "https://example.com/"
  ]
}

Authorizations

Authorization
string
header
required

Value for the Authorization header parameter.

Path Parameters

id
string
required

BillingGroup identifier

Response

BillingGroup resource

name
string
required

The name of the billing group.

Maximum length: 255
Example:

"Billing of payments at the end of the month"

type
any
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.
id
string
Example:

"01F9ZQZJZJQZJZJZJZJZJZJZJZ"

customDay
integer | null

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

Required range: 0 < x <= 31
Example:

31

customMonth
integer | null

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

Required range: 0 < x <= 12
Example:

12

subscriptions
string<iri-reference>[]

The subscriptions which are assigned to the billing group.