Skip to main content
POST
Apply automatic payments to every service

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Response

The record, as a JSON object. There is no envelope.

The account's saved payment methods, and whether every service and postpaid invoice is charged automatically.

enabled
boolean
required

Whether every service and postpaid invoice is charged to the default method.

Example:

true

pays_from_credit
boolean
required

Whether the account credit pays as much of every invoice as it can when it is due, with automatic payments on or off.

Example:

true

credit_available
boolean
required

Whether that can be chosen: account credit is offered and the billing system can apply it to every service.

Example:

true

methods
PaymentMethodData · object[]
required

Saved cards and PayPal accounts, the default first.

Example:
cards_available
boolean
required

Whether a card can be added, and whether a PayPal account can.

Example:

true

paypal_available
boolean
required

The value of paypal_available.

Example:

true