RCUR

Subscription groups

List subscription groups

get https://rcur.app/api/v2/subscription-groups

A group bundles the subscription templates a subscription can be switched between.

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

Query parameters

  • page integer

    Page number for pagination

    Default: 1

Responses

200 List of subscription groups object
  • data array of SubscriptionGroups
    5 child attributes · SubscriptionGroup
    • 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
  • links object
    4 child attributes
    • first string
    • last string
    • prev string nullable
    • next string nullable
  • meta object
    4 child attributes
    • current_page integer
    • last_page integer
    • per_page integer
    • total integer
Try it Send this request with your own API key

Requests run against the live data of the organization that owns the key.