Moneybird API

Subscription templates

Endpointhttps://moneybird.com/api/v2

Subscription templates define the products and prices for subscriptions.

deprecated

Create online sales link [Deprecated]

GET

https://moneybird.com/api/v2

/{administration_id}/subscription_templates/{id}/checkout_identifier{format}

This call generates an online sales link, which enables pre-setting the contact and start date for a subscription.

Create online sales link [Deprecated] › 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 online sales link [Deprecated] › query Parameters

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

product_id

string | integer · pattern: ^\d+$

A unique record identifier

Create online sales link [Deprecated] › Responses

A subscription template

string

GET/{administration_id}/subscription_templates/{id}/checkout_identifier{format}

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

shell

Example Responses

http://checkout.moneybird.dev/s/THJrcGxuRkVCcnNKdFVMWEQzWVVhR25TYjBaY3k5OHlsMFJpbnIrbDEyeW5sbExRZG5tMEs0S3A1M0ZZbEJxSEVVY1Zyc1BxYStoUGRaVENELzZnc3ZYalVtaUk3a1ByWmRBPS0tbDgzbHNvb21saWgyYURxTi0tcjhPWWF5WWQ4L3BaMTN5cWJ2aWpyZz09

json

application/json

Create online sales link

POST

https://moneybird.com/api/v2

/{administration_id}/subscription_templates/{id}/sales_link{format}

This call generates an online sales link, and allows pre-setting the contact and start date for a subscription. The link is valid for one hour

Create online sales link › 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 online sales link › query Parameters

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

product_id

string | integer · pattern: ^\d+$

A unique record identifier

Create online sales link › Responses

Online sales link created successfully

string

POST/{administration_id}/subscription_templates/{id}/sales_link{format}

curl --request POST \
  --url https://moneybird.com/api/v2/:administration_id/subscription_templates/:id/sales_link:format

shell

Example Responses

http://checkout.moneybird.dev/o/Y7B6by1QAoQJ

json

application/json

List all subscription templates

GET

https://moneybird.com/api/v2

/{administration_id}/subscription_templates{format}

This call retrieves a paginated list of all subscription templates available in the administration. Each page consists of up to 100 subscription templates. To access subsequent pages, utilize the page parameter to fetch the next set of subscription templates.

List all subscription templates › 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 subscription templates › query Parameters

per_page

integer | string · min: 1 · max: 100 · pattern: ^\d+$

page

integer | string

List all subscription templates › Responses

A list of subscription templates

object[]

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · 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

mergeable

boolean

contact_can_update

boolean

object[]

GET/{administration_id}/subscription_templates{format}

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

shell

Example Responses

[
  {
    "id": "471699740876080312",
    "administration_id": 123,
    "workflow_id": "471699740846720176",
    "document_style_id": "471699740806874287",
    "mergeable": false,
    "contact_can_update": true,
    "products": [
      {
        "id": "471699740867691703",
        "administration_id": 123,
        "description": "fancy product",
        "title": null,
        "identifier": null,
        "price": "10.0",
        "currency": "EUR",
        "frequency": 1,
        "frequency_type": "month",
        "tax_rate_id": "471699740856157365",
        "ledger_account_id": "471699740861400246",
        "created_at": "2025-11-25T10:52:29.642Z",
        "updated_at": "2025-11-25T10:52:29.642Z"
      }
    ]
  }
]

json

application/json

Sales invoices Subscriptions

Create online sales link [Deprecated]

GET

https://moneybird.com/api/v2

/{administration_id}/subscription_templates/{id}/checkout_identifier{format}

This call generates an online sales link, which enables pre-setting the contact and start date for a subscription.

Create online sales link [Deprecated] › 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 online sales link [Deprecated] › query Parameters

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

product_id

string | integer · pattern: ^\d+$

A unique record identifier

Create online sales link [Deprecated] › Responses

A subscription template

string

Create online sales link

POST

https://moneybird.com/api/v2

/{administration_id}/subscription_templates/{id}/sales_link{format}

This call generates an online sales link, and allows pre-setting the contact and start date for a subscription. The link is valid for one hour

Create online sales link › 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 online sales link › query Parameters

contact_id

string | integer · pattern: ^\d+$

A unique record identifier

start_date

string · date

product_id

string | integer · pattern: ^\d+$

A unique record identifier

Create online sales link › Responses

Online sales link created successfully

string

List all subscription templates

GET

https://moneybird.com/api/v2

/{administration_id}/subscription_templates{format}

List all subscription templates › 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 subscription templates › query Parameters

per_page

integer | string · min: 1 · max: 100 · pattern: ^\d+$

page

integer | string

List all subscription templates › Responses

A list of subscription templates

object[]

id

string | integer · pattern: ^\d+$

A unique record identifier

administration_id

string | integer · 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

mergeable

boolean

contact_can_update

boolean

object[]

[ { "id": "471699740876080312", "administration_id": 123, "workflow_id": "471699740846720176", "document_style_id": "471699740806874287", "mergeable": false, "contact_can_update": true, "products": [ { "id": "471699740867691703", "administration_id": 123, "description": "fancy product", "title": null, "identifier": null, "price": "10.0", "currency": "EUR", "frequency": 1, "frequency_type": "month", "tax_rate_id": "471699740856157365", "ledger_account_id": "471699740861400246", "created_at": "2025-11-25T10:52:29.642Z", "updated_at": "2025-11-25T10:52:29.642Z" } ] } ]