githubEdit

Create subscription

POST https://rcur.app/api/v2/subscriptions

Request Body

Name
Type
Description

name*

String

The name of the subscription

customer_id*

String

The ID of the customer

mollie_profile_id*

String

The ID of the Mollie profile

mollie_mandate_id*

String

The ID of the Mollie customer mandate

start_date*

Date (yyyy-mm-dd)

The start date of the subscription. Must be equal to or after today

workflow_id

Integer

The workflow ID of Moneybird. Required if the Moneybird invoice integration is enabled

docstyle_id

Integer

The docstyle ID of Moneybird. Required if the Moneybird invoice integration is enabled

rules*

Array

The rules of the subscription

Rules object

Name
Type
Description

amount*

Amount

The amount of the rule in EUR. Not required if an invoice integration is active

interval*

String

The interval of the rule. Possible options: day week month year

interval_amount*

Integer

The interval amount of the rule. Minimum amount: 1

day*

Integer

The day of charging the rule. Value depends on the chosen interval. 0 is the day of the start date

times

Integer

The number of times a rule will charge the customer. Leave out for an ongoing rule

invoice_rules

Array

The invoice rules of the subscription rule. Required if an invoice integration is enabled

Invoice rules object

Name
Type
Description

quantity*

Integer

The quantity of the invoice rule

description*

String

The description of the invoice rule

amount*

Amount

The amount of the invoice rule of a single quantity

vat*

String or Integer

The VAT of the invoice rule. Type depends on the invoice integration

ledger_account_id

String

The ledger account ID of Moneybird. Required if the Moneybird invoice integration is enabled

Last updated