Skip to main content
POST
Create a Billing Schedule

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
flow
enum<string>
required

COMMISSIONS: Representing an aggregation of commissions between your organization and a recipient (seller). PURCHASES: Representing a recurring (or on-demand) self billing flow between a supplier and your organization

Available options:
COMMISSIONS,
PURCHASES
billing_cycle_id
string | null

The ID of the billing_cycle this billing_schedule refers to. It will inherit from its recurring/on_demand data (period, and days of exeution). Leave empty if you want to select the default billing_cycle for the selected flow (see below).

customer_id
string | null

The ID of the organization that is invoiced through this billing schedule. Do not include in payload if flow=PURCHASES.

supplier_id
string | null

The ID of the organization that is the supplier of invoices through this billing schedule. Do not include in payload if flow=COMMISSIONS.

Response

successful

id
string
livemode
boolean
object
string
billing_cycle_id
string

The ID of the billing_cycle this billing_schedule is linked to.

cancelled_at
string<date-time> | null

In case of a cancellation of the schedule, the datetime to which it has been deleted

customer_id
string

The ID of the organization that is invoiced through this billing schedule

flow
enum<string>

COMMISSIONS: Representing an aggregation of commissions between your organization and a recipient (seller). PURCHASES: Representing a recurring (or on-demand) self billing flow between a supplier and your organization

Available options:
COMMISSIONS,
PURCHASES
last_billed_at
string<date-time> | null

The last time this billing schedule has been run

next_billing_date
string<date-time>

The next occurrence this billing schedule will run. null if the underlying billing cycle period is ON_DEMAND

status
enum<string>

The status of this billing_schedule. active: Is active. cancelled: has been cancelled

Available options:
active,
cancelled
supplier_id
string

The ID of the organization that is the supplier of invoices through this billing schedule

created_at
string<date-time>
updated_at
string<date-time>