Moneybird logo
Moneybird API

Subscription templates

Endpoint:https://moneybird.com/api/v2

Subscription templates define the products and prices for subscriptions.

Create online sales link

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 › path Parameters

  • administration_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • idstring | integer · pattern: ^\d+$ · required

    A unique record identifier

  • formatstring · 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_idstring | integer · pattern: ^\d+$

    A unique record identifier

  • start_datestring · date
  • product_idstring | integer · pattern: ^\d+$

    A unique record identifier

Create online sales link › Responses

A subscription template

string

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_idstring | integer · pattern: ^\d+$ · required

    The unique identifier of the administration

    A unique record identifier of an administration

  • formatstring · 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_pageinteger | string · min: 1 · max: 100 · pattern: ^\d+$
  • pageinteger | string

List all subscription templates › Responses

A list of subscription templates

  • idstring | integer · pattern: ^\d+$

    A unique record identifier

  • administration_idstring | integer · pattern: ^\d+$

    A unique record identifier of an administration

  • workflow_idstring | integer · pattern: ^\d+$

    A unique record identifier

  • document_style_idstring | integer · pattern: ^\d+$

    A unique record identifier

  • mergeableboolean
  • contact_can_updateboolean
  • productsobject[]
Sales invoicesSubscriptions