Moneybird API

Subscriptions

Endpointhttps://moneybird.com/api/v2

Subscriptions allow you to automatically invoice customers on a recurring basis for the services you provide.

Get additional charges

GET

https://moneybird.com/api/v2

/{administration_id}/subscriptions/{id}/additional_charges{format}

Get the additional charges of the given subscription.

Get additional charges › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Get additional charges › query Parameters

include_billed

boolean | string

If true, includes the additional charges that have already been billed. Default is false.

Get additional charges › Responses

A subscription additional charge

object[]

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer | null · pattern: ^\d+$

A unique record identifier

subscription_id

string | integer | null · pattern: ^\d+$

A unique record identifier

product_id

string | integer · pattern: ^\d+$

A unique record identifier

detail_id

string | integer | null · pattern: ^\d+$

A unique record identifier

amount

string | null

price

string

period

string · pattern: ^[0-9]{6}..[0-9]{6}$

description

string

GET/{administration_id}/subscriptions/{id}/additional_charges{format}

curl --request GET \
  --url https://moneybird.com/api/v2/:administration_id/subscriptions/:id/additional_charges:format

shell

Example Responses

[
  {
    "id": "471699951018050979",
    "administration_id": 123,
    "contact_id": null,
    "subscription_id": "471699950787364244",
    "product_id": "471699951009662369",
    "detail_id": null,
    "amount": "5 x",
    "price": "100.0",
    "period": "202106..202106",
    "description": "Transaction Costs"
  },
  {
    "id": "471699951032731046",
    "administration_id": 123,
    "contact_id": null,
    "subscription_id": "471699950787364244",
    "product_id": "471699951025391012",
    "detail_id": "471699951068382632",
    "amount": "5 x",
    "price": "100.0",
    "period": "202106..202106",
    "description": "Transaction Costs"
  }
]

json

application/json

Create an additional charge to be invoiced together with the subscription

POST

https://moneybird.com/api/v2

/{administration_id}/subscriptions/{id}/additional_charges{format}

At the end of the current subscription period, the additional charges are merged where possible and an invoice will be created for them. The invoice will be scheduled for sending together with the subscription invoice, so that they are merged on sending.

Create an additional charge to be invoiced together with the subscription › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Create an additional charge to be invoiced together with the subscription › Request Body

Create an additional charge to be invoiced together with the subscription › Responses

Subscription additional charge created

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer | null · pattern: ^\d+$

A unique record identifier

subscription_id

string | integer | null · pattern: ^\d+$

A unique record identifier

product_id

string | integer · pattern: ^\d+$

A unique record identifier

detail_id

string | integer | null · pattern: ^\d+$

A unique record identifier

amount

string | null

price

string

period

string · pattern: ^[0-9]{6}..[0-9]{6}$

description

string

POST/{administration_id}/subscriptions/{id}/additional_charges{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/subscriptions/:id/additional_charges:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "product_id": 471699943587841900,
  "amount": "5 x",
  "price": 100,
  "period": "20210601..20210630",
  "description": "Transaction Costs"
}
'

shell

Example Request Body

{
  "product_id": 471699943587841900,
  "amount": "5 x",
  "price": 100,
  "period": "20210601..20210630",
  "description": "Transaction Costs"
}

json

application/json

Example Responses

{
  "id": "471699943852083118",
  "administration_id": 123,
  "contact_id": null,
  "subscription_id": "471699943616153505",
  "product_id": "471699943587841947",
  "detail_id": null,
  "amount": "5 x",
  "price": "100.0",
  "period": "202106..202106",
  "description": "Transaction Costs"
}

json

application/json

Create and schedule an invoice to be sent together with the subscription

POST

https://moneybird.com/api/v2

/{administration_id}/subscriptions/{id}/create_and_schedule_one_off_sales_invoice{format}

Besides the recurring sales invoice for the subscription, you sometimes need to bill separate costs like usage based charges. Ideally you want these costs to be on the same invoice as the subscription invoice. This endpoint allows you to put extra invoice details on the subscription invoice.

This endpoint creates a new sales invoice and schedules it for sending on the same date as the next subscription invoice. During sending, Moneybird will merge both the scheduled invoice and the subscription invoice. This means the contact will receive one sales invoice with multiple invoice details, both from the subscription and from the one off sales invoice.

Create and schedule an invoice to be sent together with the subscription › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Create and schedule an invoice to be sent together with the subscription › Request Body

object

Create and schedule an invoice to be sent together with the subscription › Responses

Sales invoice created

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

string | integer | null · pattern: ^\d+$

A unique record identifier

invoice_id

string | null

recurring_sales_invoice_id

string | integer | null · pattern: ^\d+$

A unique record identifier

subscription_id

string | integer | null · pattern: ^\d+$

A unique record identifier

workflow_id

string | integer · pattern: ^\d+$

A unique record identifier

document_style_id

string | integer · pattern: ^\d+$

A unique record identifier

identity_id

string | integer · pattern: ^\d+$

A unique record identifier

draft_id

integer | null

state

string · enum

Enum values:

draft

scheduled

open

pending_payment

reminded

late

paid

uncollectible

invoice_date

string | null · date

due_date

string · date

payment_conditions

string | null

payment_reference

string | null

short_payment_reference

string | null

reference

string | null

language

string | null

currency

string

discount

string | null

original_sales_invoice_id

string | integer | null · pattern: ^\d+$

A unique record identifier

paused

boolean

paid_at

string | null · date

sent_at

string | null · date

created_at

string · date-time

updated_at

string · date-time

public_view_code

string | null

public_view_code_expires_at

string | null · date-time

version

integer

object[]

total_paid

string

total_unpaid

string

total_unpaid_base

string

prices_are_incl_tax

boolean

total_price_excl_tax

string

total_price_excl_tax_base

string

total_price_incl_tax

string

total_price_incl_tax_base

string

total_discount

string

marked_dubious_on

string | null · date

marked_uncollectible_on

string | null · date

reminder_count

integer | null

next_reminder

string | null · date

original_estimate_id

string | integer | null · pattern: ^\d+$

A unique record identifier

url

string

payment_url

string

object[]

POST/{administration_id}/subscriptions/{id}/create_and_schedule_one_off_sales_invoice{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/subscriptions/:id/create_and_schedule_one_off_sales_invoice:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "sales_invoice": {
    "details_attributes": {
      "0": {
        "description": "Extra costs subscription",
        "price": "10.5"
      }
    }
  }
}
'

shell

Example Request Body

{
  "sales_invoice": {
    "details_attributes": {
      "0": {
        "description": "Extra costs subscription",
        "price": "10.5"
      }
    }
  }
}

json

application/json

Example Responses

{
  "id": "471699947267294372",
  "administration_id": 123,
  "contact_id": "471699946994664595",
  "contact": {
    "id": "471699946994664595",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2025-11-25T10:55:46.210Z",
    "updated_at": "2025-11-25T10:55:46.210Z",
    "version": 1764068146,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/59a318a3996f5bdd1fbff1066f519075a5ca2b45b902d61a54b73c2d479de0a6/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "contact_person_id": null,
  "contact_person": null,
  "invoice_id": null,
  "recurring_sales_invoice_id": null,
  "subscription_id": null,
  "workflow_id": "471699737092818060",
  "document_style_id": "471699737325601942",
  "identity_id": "471699736591598698",
  "draft_id": 2,
  "state": "scheduled",
  "invoice_date": "2025-12-01",
  "due_date": "2025-12-15",
  "payment_conditions": "We verzoeken u vriendelijk het bovenstaande bedrag van {document.total_price} voor {document.due_date} te voldoen op onze bankrekening onder vermelding van de omschrijving {document.payment_reference}. Voor vragen kunt u contact opnemen per e-mail.",
  "payment_reference": null,
  "short_payment_reference": null,
  "reference": null,
  "language": "nl",
  "currency": "EUR",
  "discount": "0.0",
  "original_sales_invoice_id": null,
  "paused": false,
  "paid_at": null,
  "sent_at": null,
  "created_at": "2025-11-25T10:55:46.210Z",
  "updated_at": "2025-11-25T10:55:46.210Z",
  "public_view_code": null,
  "public_view_code_expires_at": null,
  "version": 1764068146,
  "details": [
    {
      "id": "471699947269391525",
      "administration_id": 123,
      "tax_rate_id": "471699736823334023",
      "ledger_account_id": "471699736746787959",
      "project_id": null,
      "product_id": null,
      "amount": null,
      "amount_decimal": "1.0",
      "description": "Extra costs subscription",
      "price": "10.5",
      "period": null,
      "row_order": 0,
      "total_price_excl_tax_with_discount": "10.5",
      "total_price_excl_tax_with_discount_base": "10.5",
      "tax_report_reference": [
        "NL/1a"
      ],
      "mandatory_tax_text": null,
      "created_at": "2025-11-25T10:55:46.210Z",
      "updated_at": "2025-11-25T10:55:46.210Z"
    }
  ],
  "payments": [],
  "total_paid": "0.0",
  "total_unpaid": "12.71",
  "total_unpaid_base": "12.71",
  "prices_are_incl_tax": false,
  "total_price_excl_tax": "10.5",
  "total_price_excl_tax_base": "10.5",
  "total_price_incl_tax": "12.71",
  "total_price_incl_tax_base": "12.71",
  "total_discount": "0.0",
  "marked_dubious_on": null,
  "marked_uncollectible_on": null,
  "reminder_count": 0,
  "next_reminder": null,
  "original_estimate_id": null,
  "url": "http://moneybird.dev/123/external/59a318a3996f5bdd1fbff1066f519075a5ca2b45b902d61a54b73c2d479de0a6/0b4cd85b3d13a282d5e6c259ac1aed339dcbacc54594269c11b27a6836f3082d/sales_invoice",
  "payment_url": "http://moneybird.dev/123/external/59a318a3996f5bdd1fbff1066f519075a5ca2b45b902d61a54b73c2d479de0a6/0b4cd85b3d13a282d5e6c259ac1aed339dcbacc54594269c11b27a6836f3082d/sales_invoice",
  "custom_fields": [],
  "notes": [],
  "attachments": [],
  "events": [
    {
      "administration_id": 123,
      "user_id": 17640679459010,
      "action": "sales_invoice_created",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-11-25T10:55:46.210Z",
      "updated_at": "2025-11-25T10:55:46.210Z"
    },
    {
      "administration_id": 123,
      "user_id": 17640679459010,
      "action": "sales_invoice_state_changed_to_scheduled",
      "link_entity_id": null,
      "link_entity_type": null,
      "data": {},
      "created_at": "2025-11-25T10:55:46.210Z",
      "updated_at": "2025-11-25T10:55:46.210Z"
    }
  ],
  "tax_totals": [
    {
      "tax_rate_id": "471699736823334023",
      "taxable_amount": "10.5",
      "taxable_amount_base": "10.5",
      "tax_amount": "2.21",
      "tax_amount_base": "2.21"
    }
  ],
  "time_entries": []
}

json

application/json

Get subscription

GET

https://moneybird.com/api/v2

/{administration_id}/subscriptions/{id}{format}

Get a subscription.

Get subscription › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Get subscription › Responses

A subscription

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

end_date

string | null · date

frequency

integer | null

frequency_type

string | null · enum

Enum values:

day

week

month

quarter

year

reference

string | null

cancelled_at

string | null · date-time

product_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

string | integer | null · pattern: ^\d+$

A unique record identifier

object[]

recurring_sales_invoice_id

string | integer | null · pattern: ^\d+$

A unique record identifier

GET/{administration_id}/subscriptions/{id}{format}

curl --request GET \
  --url https://moneybird.com/api/v2/:administration_id/subscriptions/:id:format

shell

Example Responses

{
  "id": "471699944244250570",
  "administration_id": 123,
  "start_date": "2017-01-01",
  "end_date": null,
  "frequency": 1,
  "frequency_type": "month",
  "reference": null,
  "cancelled_at": null,
  "product_id": "471699944231667656",
  "product": {
    "id": "471699944231667656",
    "administration_id": 123,
    "description": "My product description",
    "title": null,
    "identifier": null,
    "price": "20.0",
    "currency": "EUR",
    "frequency": 1,
    "frequency_type": "month",
    "tax_rate_id": "471699736823334023",
    "ledger_account_id": "471699736746787959",
    "created_at": "2025-11-25T10:55:43.584Z",
    "updated_at": "2025-11-25T10:55:43.584Z"
  },
  "contact_id": "471699944216987590",
  "contact": {
    "id": "471699944216987590",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2025-11-25T10:55:43.570Z",
    "updated_at": "2025-11-25T10:55:43.570Z",
    "version": 1764068143,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/40f3fe754b42bf489f2f9760b9d9ac3004e06e0608e6b047b99f103619d04f9c/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "contact_person_id": null,
  "contact_person": null,
  "subscription_products": [
    {
      "start_date": "2017-01-01",
      "end_date": null,
      "product_id": "471699944231667656",
      "product": {
        "id": "471699944231667656",
        "administration_id": 123,
        "description": "My product description",
        "title": null,
        "identifier": null,
        "price": "20.0",
        "currency": "EUR",
        "frequency": 1,
        "frequency_type": "month",
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "created_at": "2025-11-25T10:55:43.584Z",
        "updated_at": "2025-11-25T10:55:43.584Z"
      },
      "amount": "1 x",
      "discount": "0.0"
    }
  ],
  "recurring_sales_invoice_id": "471699944275707853"
}

json

application/json

Cancel a subscription

DELETE

https://moneybird.com/api/v2

/{administration_id}/subscriptions/{id}{format}

Cancels the subscription. Stops the recurring sales invoice for the contact. Optionally you can provide an end_date to stop the subscription on a future date.

Cancel a subscription › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Cancel a subscription › Request Body

object

Cancel a subscription › Responses

Subscription cancelled

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

end_date

string | null · date

frequency

integer | null

frequency_type

string | null · enum

Enum values:

day

week

month

quarter

year

reference

string | null

cancelled_at

string | null · date-time

product_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

string | integer | null · pattern: ^\d+$

A unique record identifier

object[]

recurring_sales_invoice_id

string | integer | null · pattern: ^\d+$

A unique record identifier

DELETE/{administration_id}/subscriptions/{id}{format}

curl --request DELETE \
  --url https://moneybird.com/api/v2/:administration_id/subscriptions/:id:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscription": {
    "end_date": "2025-11-27"
  }
}
'

shell

Example Request Body

{
  "subscription": {
    "end_date": "2025-11-27"
  }
}

json

application/json

Example Responses

{
  "id": "471699945138684929",
  "administration_id": 123,
  "start_date": "2017-01-01",
  "end_date": "2025-11-27",
  "frequency": 1,
  "frequency_type": "month",
  "reference": null,
  "cancelled_at": "2025-11-25T10:55:44.677Z",
  "product_id": "471699945125054463",
  "product": {
    "id": "471699945125054463",
    "administration_id": 123,
    "description": "My product description",
    "title": null,
    "identifier": null,
    "price": "20.0",
    "currency": "EUR",
    "frequency": 1,
    "frequency_type": "month",
    "tax_rate_id": "471699736823334023",
    "ledger_account_id": "471699736746787959",
    "created_at": "2025-11-25T10:55:44.436Z",
    "updated_at": "2025-11-25T10:55:44.436Z"
  },
  "contact_id": "471699945109325821",
  "contact": {
    "id": "471699945109325821",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2025-11-25T10:55:44.420Z",
    "updated_at": "2025-11-25T10:55:44.420Z",
    "version": 1764068144,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/d0fa1da455fad75341691f570b8a661c69d6b29c7f900641d3344e3eaa7b3771/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "contact_person_id": null,
  "contact_person": null,
  "subscription_products": [
    {
      "start_date": "2017-01-01",
      "end_date": "2025-11-27",
      "product_id": "471699945125054463",
      "product": {
        "id": "471699945125054463",
        "administration_id": 123,
        "description": "My product description",
        "title": null,
        "identifier": null,
        "price": "20.0",
        "currency": "EUR",
        "frequency": 1,
        "frequency_type": "month",
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "created_at": "2025-11-25T10:55:44.436Z",
        "updated_at": "2025-11-25T10:55:44.436Z"
      },
      "amount": "1 x",
      "discount": "0.0"
    }
  ],
  "recurring_sales_invoice_id": "471699945176433668"
}

json

application/json

Update a subscription

PATCH

https://moneybird.com/api/v2

/{administration_id}/subscriptions/{id}{format}

Updates the product the contact is subscribed to. This will automatically calculate the differences between the product prices and create a one off sales invoice to bill the extra charge for the remaining billing period.

Optionally you can provide a start date for the product change to become active.

Update a subscription › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

id

string | integer · pattern: ^\d+$ · required

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Update a subscription › Request Body

object

Update a subscription › Responses

Subscription updated

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

end_date

string | null · date

frequency

integer | null

frequency_type

string | null · enum

Enum values:

day

week

month

quarter

year

reference

string | null

cancelled_at

string | null · date-time

product_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

string | integer | null · pattern: ^\d+$

A unique record identifier

object[]

recurring_sales_invoice_id

string | integer | null · pattern: ^\d+$

A unique record identifier

PATCH/{administration_id}/subscriptions/{id}{format}

curl --request PATCH \
  --url https://moneybird.com/api/v2/:administration_id/subscriptions/:id:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscription": {
    "product_id": 471699948574868740,
    "discount": 10,
    "amount": "3 x"
  }
}
'

shell

Example Request Body

{
  "subscription": {
    "product_id": 471699948574868740,
    "discount": 10,
    "amount": "3 x"
  }
}

json

application/json

Example Responses

{
  "id": "471699948615763196",
  "administration_id": 123,
  "start_date": "2017-01-01",
  "end_date": null,
  "frequency": 1,
  "frequency_type": "month",
  "reference": null,
  "cancelled_at": null,
  "product_id": "471699948574868724",
  "product": {
    "id": "471699948574868724",
    "administration_id": 123,
    "description": "My product description",
    "title": null,
    "identifier": null,
    "price": "30.0",
    "currency": "EUR",
    "frequency": 1,
    "frequency_type": "month",
    "tax_rate_id": "471699736823334023",
    "ledger_account_id": "471699736746787959",
    "created_at": "2025-11-25T10:55:47.727Z",
    "updated_at": "2025-11-25T10:55:47.727Z"
  },
  "contact_id": "471699948590597368",
  "contact": {
    "id": "471699948590597368",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2025-11-25T10:55:47.741Z",
    "updated_at": "2025-11-25T10:55:47.741Z",
    "version": 1764068147,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/23917906c049e37009e89e37d26f2ca1070e889b3845518f73445871c1c4a55b/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "contact_person_id": null,
  "contact_person": null,
  "subscription_products": [
    {
      "start_date": "2017-01-01",
      "end_date": "2025-11-24",
      "product_id": "471699948603180282",
      "product": {
        "id": "471699948603180282",
        "administration_id": 123,
        "description": "My product description",
        "title": null,
        "identifier": null,
        "price": "20.0",
        "currency": "EUR",
        "frequency": 1,
        "frequency_type": "month",
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "created_at": "2025-11-25T10:55:47.753Z",
        "updated_at": "2025-11-25T10:55:47.753Z"
      },
      "amount": "1 x",
      "discount": "0.0"
    },
    {
      "start_date": "2025-11-25",
      "end_date": null,
      "product_id": "471699948574868724",
      "product": {
        "id": "471699948574868724",
        "administration_id": 123,
        "description": "My product description",
        "title": null,
        "identifier": null,
        "price": "30.0",
        "currency": "EUR",
        "frequency": 1,
        "frequency_type": "month",
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "created_at": "2025-11-25T10:55:47.727Z",
        "updated_at": "2025-11-25T10:55:47.727Z"
      },
      "amount": "3 x",
      "discount": "10.0"
    }
  ],
  "recurring_sales_invoice_id": "471699948648269055"
}

json

application/json

List all subscriptions

GET

https://moneybird.com/api/v2

/{administration_id}/subscriptions{format}

Lists all subscriptions for the given contact.

List all subscriptions › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

List all subscriptions › query Parameters

contact_id

string | integer · pattern: ^\d+$ · required

A unique record identifier

List all subscriptions › Responses

200

A list of subscriptions

object[]

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

end_date

string | null · date

frequency

integer | null

frequency_type

string | null · enum

Enum values:

day

week

month

quarter

year

reference

string | null

cancelled_at

string | null · date-time

product_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

string | integer | null · pattern: ^\d+$

A unique record identifier

object[]

recurring_sales_invoice_id

string | integer | null · pattern: ^\d+$

A unique record identifier

GET/{administration_id}/subscriptions{format}

curl --request GET \
  --url 'https://moneybird.com/api/v2/:administration_id/subscriptions:format?contact_id=471699946122249284'

shell

Example Responses

[
  {
    "id": "471699946148463688",
    "administration_id": 123,
    "start_date": "2017-01-01",
    "end_date": null,
    "frequency": 1,
    "frequency_type": "month",
    "reference": null,
    "cancelled_at": null,
    "product_id": "471699946135880774",
    "product": {
      "id": "471699946135880774",
      "administration_id": 123,
      "description": "My product description",
      "title": null,
      "identifier": null,
      "price": "20.0",
      "currency": "EUR",
      "frequency": 1,
      "frequency_type": "month",
      "tax_rate_id": "471699736823334023",
      "ledger_account_id": "471699736746787959",
      "created_at": "2025-11-25T10:55:45.400Z",
      "updated_at": "2025-11-25T10:55:45.400Z"
    },
    "contact_id": "471699946122249284",
    "contact": {
      "id": "471699946122249284",
      "administration_id": 123,
      "company_name": "Foobar Holding B.V.",
      "firstname": "",
      "lastname": "",
      "address1": "Hoofdstraat 12",
      "address2": "",
      "zipcode": "1234AB",
      "city": "Amsterdam",
      "country": "NL",
      "phone": "",
      "delivery_method": "Email",
      "customer_id": "1",
      "tax_number": "",
      "chamber_of_commerce": "",
      "bank_account": "",
      "is_trusted": false,
      "max_transfer_amount": null,
      "attention": "",
      "email": "info@example.com",
      "email_ubl": true,
      "send_invoices_to_attention": "",
      "send_invoices_to_email": "info@example.com",
      "send_estimates_to_attention": "",
      "send_estimates_to_email": "info@example.com",
      "sepa_active": false,
      "sepa_iban": "",
      "sepa_iban_account_name": "",
      "sepa_bic": "",
      "sepa_mandate_id": "",
      "sepa_mandate_date": null,
      "sepa_sequence_type": "RCUR",
      "credit_card_number": "",
      "credit_card_reference": "",
      "credit_card_type": null,
      "tax_number_validated_at": null,
      "tax_number_valid": null,
      "invoice_workflow_id": null,
      "estimate_workflow_id": null,
      "si_identifier": "",
      "si_identifier_type": null,
      "moneybird_payments_mandate": false,
      "created_at": "2025-11-25T10:55:45.387Z",
      "updated_at": "2025-11-25T10:55:45.387Z",
      "version": 1764068145,
      "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/02739a274ba709fae9a2cd1128e7563634d511ae2a90d4c7aac8534493bb6b05/all",
      "notes": [],
      "custom_fields": [],
      "contact_people": [],
      "archived": false
    },
    "contact_person_id": null,
    "contact_person": null,
    "subscription_products": [
      {
        "start_date": "2017-01-01",
        "end_date": null,
        "product_id": "471699946135880774",
        "product": {
          "id": "471699946135880774",
          "administration_id": 123,
          "description": "My product description",
          "title": null,
          "identifier": null,
          "price": "20.0",
          "currency": "EUR",
          "frequency": 1,
          "frequency_type": "month",
          "tax_rate_id": "471699736823334023",
          "ledger_account_id": "471699736746787959",
          "created_at": "2025-11-25T10:55:45.400Z",
          "updated_at": "2025-11-25T10:55:45.400Z"
        },
        "amount": "1 x",
        "discount": "0.0"
      }
    ],
    "recurring_sales_invoice_id": "471699946179920971"
  }
]

json

application/json

Create a new subscription

POST

https://moneybird.com/api/v2

/{administration_id}/subscriptions{format}

Starts a new subscription for the given contact. The product_id points to a product with a frequency, price and description. A recurring sales invoice is automatically created to bill the contact for the given frequency. The first invoice will be sent on the start date, but no sooner than tomorrow. The reference will be added to the sales invoices.

Optionally you can create a subscription with a different frequency than stored in the product. Make sure the frequency of the product and the provided frequency are compatible. E.g. you can bill a monthly product yearly.

Create a new subscription › path Parameters

administration_id

string | integer · pattern: ^\d+$ · required

The unique identifier of the administration

A unique record identifier

format

string · pattern: ^(.(json|xml))?$ · required

The format in which the response is given, can be empty to use the default format

Default: .json

Create a new subscription › Request Body

object

Create a new subscription › Responses

Subscription created

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

end_date

string | null · date

frequency

integer | null

frequency_type

string | null · enum

Enum values:

day

week

month

quarter

year

reference

string | null

cancelled_at

string | null · date-time

product_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

object

contact_person_id

string | integer | null · pattern: ^\d+$

A unique record identifier

object[]

recurring_sales_invoice_id

string | integer | null · pattern: ^\d+$

A unique record identifier

POST/{administration_id}/subscriptions{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/subscriptions:format \
  --header 'Content-Type: application/json' \
  --data '
{
  "subscription": {
    "start_date": "2025-11-26",
    "contact_id": 471699946533291140,
    "product_id": 471699946546922600,
    "reference": "moneybird.nl",
    "discount": 10,
    "amount": "5x"
  }
}
'

shell

Example Request Body

{
  "subscription": {
    "start_date": "2025-11-26",
    "contact_id": 471699946533291140,
    "product_id": 471699946546922600,
    "reference": "moneybird.nl",
    "discount": 10,
    "amount": "5x"
  }
}

json

application/json

Example Responses

{
  "id": "471699946563699816",
  "administration_id": 123,
  "start_date": "2025-11-26",
  "end_date": null,
  "frequency": 1,
  "frequency_type": "month",
  "reference": "moneybird.nl",
  "cancelled_at": null,
  "product_id": "471699946546922598",
  "product": {
    "id": "471699946546922598",
    "administration_id": 123,
    "description": "My product description",
    "title": null,
    "identifier": null,
    "price": "20.0",
    "currency": "EUR",
    "frequency": 1,
    "frequency_type": "month",
    "tax_rate_id": "471699736823334023",
    "ledger_account_id": "471699736746787959",
    "created_at": "2025-11-25T10:55:45.792Z",
    "updated_at": "2025-11-25T10:55:45.792Z"
  },
  "contact_id": "471699946533291108",
  "contact": {
    "id": "471699946533291108",
    "administration_id": 123,
    "company_name": "Foobar Holding B.V.",
    "firstname": "",
    "lastname": "",
    "address1": "Hoofdstraat 12",
    "address2": "",
    "zipcode": "1234AB",
    "city": "Amsterdam",
    "country": "NL",
    "phone": "",
    "delivery_method": "Email",
    "customer_id": "1",
    "tax_number": "",
    "chamber_of_commerce": "",
    "bank_account": "",
    "is_trusted": false,
    "max_transfer_amount": null,
    "attention": "",
    "email": "info@example.com",
    "email_ubl": true,
    "send_invoices_to_attention": "",
    "send_invoices_to_email": "info@example.com",
    "send_estimates_to_attention": "",
    "send_estimates_to_email": "info@example.com",
    "sepa_active": false,
    "sepa_iban": "",
    "sepa_iban_account_name": "",
    "sepa_bic": "",
    "sepa_mandate_id": "",
    "sepa_mandate_date": null,
    "sepa_sequence_type": "RCUR",
    "credit_card_number": "",
    "credit_card_reference": "",
    "credit_card_type": null,
    "tax_number_validated_at": null,
    "tax_number_valid": null,
    "invoice_workflow_id": null,
    "estimate_workflow_id": null,
    "si_identifier": "",
    "si_identifier_type": null,
    "moneybird_payments_mandate": false,
    "created_at": "2025-11-25T10:55:45.779Z",
    "updated_at": "2025-11-25T10:55:45.779Z",
    "version": 1764068145,
    "sales_invoices_url": "https://moneybird.dev/123/sales_invoices/aa60f813310c87f330fdc86701f477bbaff44aeb2dd45893ef134da6e9c649fc/all",
    "notes": [],
    "custom_fields": [],
    "contact_people": [],
    "archived": false
  },
  "contact_person_id": null,
  "contact_person": null,
  "subscription_products": [
    {
      "start_date": "2025-11-26",
      "end_date": null,
      "product_id": "471699946546922598",
      "product": {
        "id": "471699946546922598",
        "administration_id": 123,
        "description": "My product description",
        "title": null,
        "identifier": null,
        "price": "20.0",
        "currency": "EUR",
        "frequency": 1,
        "frequency_type": "month",
        "tax_rate_id": "471699736823334023",
        "ledger_account_id": "471699736746787959",
        "created_at": "2025-11-25T10:55:45.792Z",
        "updated_at": "2025-11-25T10:55:45.792Z"
      },
      "amount": "5x",
      "discount": "10.0"
    }
  ],
  "recurring_sales_invoice_id": "471699946598302827"
}

json

application/json

Subscription templates Tax rates