Create Recurring Billing

post

https://api.coingate.com/api/v2/billing/recurrings

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Recurring Billing automatically generates and sends a billing request (invoice) to your client at a fixed interval. You define the frequency (weekly or monthly), the start_at date, and an optional end_at date. Billings are then generated and sent on schedule until the recurrence ends or is cancelled.

Body Params

billing_contact_id

int32

required

Billing Contact ID.

title

string

Request title.

currency_id

int32

required

Currency of amount. Currency ID's can be seen on https://developer.coingate.com/reference/currencies.

amount

string

Amount is required only when the request is created without associated products. If products are included, the amount is automatically calculated based on the product prices and quantities.

receive_currency_id

int32

required

Currency ID's can be seen on https://developer.coingate.com/reference/currencies.

frequency

string

enum

required

How often billing occurs. Possible values: weekly, monthly.

Allowed:

start_at

date

required

When the first billing will be sent to the client. If set to a future date, the first billing will be created as a scheduled item and sent on the start_at date. This date also acts as the anchor day for subsequent recurring billings.

end_at

date

Indicates when recurring billings stop. If not set, billings will continue indefinitely.

underpaid_cover_pct

integer

Defaults to 0

How much percentage of underpaid can be covered. Max: 10.

callback_url

string

Send an automated message to Merchant URL when request status is changed. For testing you can use requestcatcher.com tool. URL must be direct without redirection. Read about billing request callbacks here.

billing_request_items

object

Billing Products and quantity. If present amount will calculated based on product price and quantity.

Responses

200200

422422