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

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Pfadparameter

​
id
string
erforderlich

BillingGroup identifier

Antwort

BillingGroup resource

​
name
string
erforderlich

The name of the billing group.

Maximum string length: 255
Beispiel:

"Billing of payments at the end of the month"

​
type
any
erforderlich
read-only

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.
Beispiel:

"end_of_month"

​
id
string
read-only
Beispiel:

"01F9ZQZJZJQZJZJZJZJZJZJZJZ"

​
customDay
integer | null
read-only

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

Erforderlicher Bereich: x <= 31
Beispiel:

31

​
customMonth
integer | null
read-only

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

Erforderlicher Bereich: x <= 12
Beispiel:

12

​
subscriptions
string<uuid>[]

The subscriptions which are assigned to the billing group.