Create invoice

post

https://api.synapto.construction/v1/accounts/*/invoices

Required capability: billing

Body Params

customer

string

required

Customer to bill.

Example: "accounts/acct_RwDJsJd8z0exhtfX2570Q/customers/cus_b7OA3d8UcuWjG23Rnyh0H"

currency

string

required

Currency of the invoice, this is restricted by the available set of present currencies.

Example: "GBP".

default_tax_rates

array of strings

Invoice-level tax rate applied to any line item that doesn't define it's own tax_rate.

default_tax_rates

collection_method

string

enum

How an invoice or subscription is collected from the customer.

CHARGE_AUTOMATICALLY: the system attempts to auto-charge the customer's saved payment method. REQUEST_PAYMENT: an invoice is issued to the customer and settled out-of-band (manual pay).

Allowed:

metadata

object

Client supplied metadata. At most 50 keys with a max length of 40 characters are permitted. Values may be strings up to 500 characters each.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A successful response.