Subscription groups

Update subscription group

put https://rcur.app/api/v2/subscription-groups/{id}

Fields left out keep their value. When plans is given it is the complete list: templates that are not in it leave the group.

Requires your API key as Authorization: Bearer <key>. See authentication.

Path parameters

id string required

Request body

application/json

Fields left out keep their value. Plans replaces the whole list.

name string
description string

Only for yourself, customers do not see it
plans array of objects

The complete list of templates in the group, in the order customers see them
3 child attributes
- template_id string required
  
  Id of a subscription template
- plan_name string
  
  Name shown in the customer portal when switching, the template name when empty
- plan_description string
  
  Text shown in the customer portal when switching

Responses

200 Subscription group details SubscriptionGroup object

id string required
name string required
description string nullable

Only for yourself, customers do not see it
plans array of SubscriptionTemplates required

The templates a subscription of the group can be switched between, in the order customers see them
8 child attributes · SubscriptionTemplate
- id string required
- name string required
  
  Name of the template
- description string
  
  Description the subscriptions made from the template get
- currency string required
- group_id string nullable
  
  The subscription group the template is in
- plan_name string nullable
  
  Name shown in the customer portal when switching
- plan_description string nullable
  
  Text shown in the customer portal when switching
- rules array of SubscriptionRules required
  8 child attributes · SubscriptionRule
  
  id string required
  
  amount string required
  
  currency string required
  
  One of AED AUD BGN BRL CAD CHF CZK DKK EUR GBP HKD HUF ILS ISK JPY MXN MYR NOK NZD PHP PLN RON SEK SGD THB TWD USD ZAR
  
  interval string required
  
  One of day week month year
  
  interval_amount integer required
  
  day integer required
  
  times integer nullable
  
  times_done integer required
created_at string required

404 Resource not found Error object

status integer required
error string required

422 Validation error ValidationError object

status integer required
error string required
fields object

Try it Send this request with your own API key

Requests run against the live data of the organization that owns the key. This PUT request changes that data.

API key Kept in this browser tab only. id path, required Body JSON

curl -X PUT https://rcur.app/api/v2/subscription-groups/YJRQAMRQ6y \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Groentebox",
  "description": "string",
  "plans": [
    {
      "template_id": "aB3dE5fG7h",
      "plan_name": "Klein",
      "plan_description": "string"
    }
  ]
}'

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://rcur.app/api/v2/subscription-groups/YJRQAMRQ6y', [
    'headers' => [
        'Authorization' => 'Bearer YOUR_API_KEY',
        'Accept' => 'application/json',
    ],
    'json' => [
        'name' => 'Groentebox',
        'description' => 'string',
        'plans' => [
            [
                'template_id' => 'aB3dE5fG7h',
                'plan_name' => 'Klein',
                'plan_description' => 'string',
            ],
        ],
    ],
]);

$data = json_decode($response->getBody(), true);

const response = await fetch('https://rcur.app/api/v2/subscription-groups/YJRQAMRQ6y', {
  method: 'PUT',
  headers: {
    Authorization: 'Bearer YOUR_API_KEY',
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Groentebox",
    "description": "string",
    "plans": [
      {
        "template_id": "aB3dE5fG7h",
        "plan_name": "Klein",
        "plan_description": "string"
      }
    ]
  }),
});

const data = await response.json();

import requests

response = requests.request(
    'PUT',
    'https://rcur.app/api/v2/subscription-groups/YJRQAMRQ6y',
    headers={'Authorization': 'Bearer YOUR_API_KEY', 'Accept': 'application/json'},
    json={
        "name": "Groentebox",
        "description": "string",
        "plans": [
            {
                "template_id": "aB3dE5fG7h",
                "plan_name": "Klein",
                "plan_description": "string"
            }
        ]
    },
)

data = response.json()

{
    "id": "xY1zA2bC3d",
    "name": "Groentebox",
    "description": null,
    "plans": [
        {
            "id": "aB3dE5fG7h",
            "name": "Groentebox klein",
            "description": "Groentebox klein, wekelijks",
            "currency": "EUR",
            "group_id": "xY1zA2bC3d",
            "plan_name": "Klein",
            "plan_description": null,
            "rules": [
                {
                    "id": "rule_abc123",
                    "amount": "29.99",
                    "currency": "EUR",
                    "interval": "month",
                    "interval_amount": 1,
                    "day": 1,
                    "times": 12,
                    "times_done": 3
                }
            ]
        }
    ],
    "created_at": "2026-10-31 10:00:00"
}

{
    "status": 404,
    "error": "Resource not found"
}

{
    "status": 422,
    "error": "Could not process request. Some fields contain invalid data",
    "fields": {
        "email": [
            "The email field is required."
        ]
    }
}