Subscription templates

cURL Ruby

List all subscription templates

GET /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.

Parameters

Parameter	Type	Description
`per_page`	`Integer`
`page`	`Integer`

Example: lists subscription templates for the administration

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/subscription_templates.json?
    
    

Response

        
          
          Status: 200 OK

[
  {
    "id": "460922336946685763",
    "administration_id": 123,
    "workflow_id": "460922336909985595",
    "document_style_id": "460922336871188282",
    "mergeable": false,
    "contact_can_update": true,
    "products": [
      {
        "id": "460922336932005698",
        "administration_id": 123,
        "description": "fancy product",
        "title": null,
        "identifier": null,
        "price": "10.0",
        "currency": "EUR",
        "frequency": 1,
        "frequency_type": "month",
        "tax_rate_id": "460922336920471360",
        "ledger_account_id": "460922336926762817",
        "created_at": "2025-07-29T11:50:16.309Z",
        "updated_at": "2025-07-29T11:50:16.309Z"
      }
    ]
  }
]

Create online sales link

GET /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.

Parameters

Parameter	Type	Description
`contact_id`	`Integer`
`start_date`	`Date`
`product_id`	`Integer`

Example: creates an online sales link

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/subscription_templates/460922337416447839/checkout_identifier.json?contact_id=460922337423787874&start_date=2025-07-29
    
    

Response

        
          
          Status: 200 OK

"http://checkout.moneybird.dev/s/cXFDelFlWnlYclVXUlQxZEdCMk8vZmRidDJraE1SbjBJYldPS2xhQVl4MzJzMWdVdFpXbHo4SkU4Q0ttdzhJVTdDMWdTMTZxWWNRZUIxdCtMUGFTcGFXemc2VE5XZEZOQUVnPS0tSXV3Y2N2NzdGVXl3ZDJvMi0tS2dmSUwxQUcweVExY2VCVmZhQTE5Zz09"

Example: creates an online sales link if no contact_id is provided

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/subscription_templates/460922337655523183/checkout_identifier.json?start_date=2025-07-29
    
    

Response

        
          
          Status: 200 OK

"http://checkout.moneybird.dev/s/VklNT1RoNlVrTlo1djAzUi9yTm1sdTU4RkY3cE8wdGEzOVB0Qml2SjMxbFJpK2xNZnc1dWdXcWNkOG8ydHgvUW0yWG1QUT09LS00L1lrM0k2azVtSG03eUUrLS1PTTdMTWl1T2ZqRWpDSCtvc0VBMlRnPT0="

Example: creates an online sales link for a product

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/subscription_templates/460922337894598525/checkout_identifier.json?product_id=460922337901938559&start_date=2025-07-29
    
    

Response

        
          
          Status: 200 OK

"http://checkout.moneybird.dev/stp/MmRMRzR2dkVIY2ZIS2J1eGZoMEY0VkN6cTFxNVA0M2psVFliYlRzajJ3S0Z1UTgySTArUjhKcy9HRVZMUW52WWFKUjd4UT09LS1LT2FnSVBUbUtRMHk4azNsLS15Yno1ZjBocEtrWHFPRXFWQ0dFbGVnPT0="

Example: returns 404 when the product is not found

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/subscription_templates/460922338126333837/checkout_identifier.json?product_id=460922338139965327&start_date=2025-07-29
    
    

Response

        
          
          Status: 404 Not Found

{
  "error": "Product not found for subscription template"
}

Example: returns 404 if contact is not found

Request

    curl -s -H "Content-Type: application/json" -H "Authorization: Bearer 84ec207ad0154a508f798e615a998ac1fd752926d00f955fb1df3e144cba44ab" \
  -XGET \
  https://moneybird.com/api/v2/123/subscription_templates/460922338397915041/checkout_identifier.json?contact_id=460922338288863124&start_date=2025-07-29
    
    

Response

        
          
          Status: 404 Not Found

{
  "error": "Record not found for model name: Contact"
}