RCUR

Subscriptions

Create subscription

post https://rcur.app/api/v2/subscriptions

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

Request body

application/json

Subscription data

  • name string required

    Subscription name

  • customer_id string required

    Customer hash ID

  • mollie_profile_id string required

    Mollie profile ID

  • mollie_mandate_id string required

    Mollie mandate ID

  • customer_portal string

    Can the customer pause and cancel this subscription in the customer portal: inherit follows the customer portal settings, allow and deny overrule them. Defaults to inherit

    One of inherit allow deny

  • customer_portal_notice_period string

    Notice period when the customer cancels in the customer portal: inherit follows the customer portal settings. Defaults to inherit

    One of inherit none 14_days 1_month 2_months 3_months 1_year

  • custom_fields object

    Answers to custom fields, keyed by custom field id (see /custom-fields). A checkbox takes true or false, a number a number, a date YYYY-MM-DD. Send null or an empty string to clear an answer; fields you leave out stay as they are.

  • customer_portal_min_duration string

    How long the subscription has to run before the customer can cancel it in the customer portal: inherit follows the customer portal settings. Defaults to inherit

    One of inherit none 1_month 3_months 6_months 1_year 2_years

  • start_date string required

    Start date (Y-m-d)

  • workflow_id string

    Invoice workflow ID (required for Moneybird)

  • docstyle_id string

    Document style ID (required for Moneybird). For WeFact the language code of the invoice template (huisstijl); leave out to use the default

  • rules array of objects required

    Subscription rules

    7 child attributes
    • amount number

      Amount per interval

    • interval string

      Interval type

      One of day week month year

    • interval_amount integer

      Number of intervals

    • day integer

      Day of interval (0-365)

    • times integer

      Number of times (null = infinite)

    • docstyle_id string

      Document style ID (Moneybird) or invoice template language code (WeFact) for the invoices of this rule. Overrides the subscription docstyle_id; leave out to use that one

    • invoice_rules array of objects

      Invoice rules (when invoicing is enabled)

      5 child attributes
      • quantity integer
      • description string
      • amount number
      • vat string
      • ledger_account_id string

Responses

200 Subscription details Subscription object
  • id string required
  • name string required
  • status string required

    One of draft active paused cancelled completed

  • start_date string required
  • mollie_mandate_id string
  • mollie_profile_id string
  • next_payment_at string nullable
  • next_amount string nullable
  • last_payment_created_at string nullable
  • resume_at string nullable
  • cancel_at string nullable
  • customer_portal string

    Can the customer pause and cancel this subscription in the customer portal: inherit follows the customer portal settings, allow and deny overrule them

    One of inherit allow deny

  • customer_portal_notice_period string

    Notice period when the customer cancels in the customer portal: inherit follows the customer portal settings

    One of inherit none 14_days 1_month 2_months 3_months 1_year

  • customer_portal_min_duration string

    How long the subscription has to run before the customer can cancel it in the customer portal: inherit follows the customer portal settings.

    One of inherit none 1_month 3_months 6_months 1_year 2_years

  • plan object nullable

    The subscription template the subscription runs on, when it can be switched in a subscription group

    3 child attributes
    • template_id string
    • group_id string nullable
    • name string
  • discount SubscriptionDiscount object

    The discount that lowers the next payments of the subscription

    10 child attributes · SubscriptionDiscount
    • discount_id string nullable

      The discount code it came from; null for a discount without a code

    • code string nullable
    • type string required

      One of percentage fixed

    • value string required
    • currency string nullable
    • duration string required

      One of once repeating forever

    • periods_total integer nullable
    • periods_used integer required
    • total_discounted string required
    • created_at string
  • created_at string required
  • rules array of SubscriptionRules
    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
  • customer object
  • custom_fields array of CustomFieldValues

    Answers to custom fields. Only present when the organization has custom fields.

    5 child attributes · CustomFieldValue
    • field_id string nullable

      Id of the custom field, empty when the field has been deleted since

    • label string required

      The question as it was asked

    • type string required

      One of text textarea number select checkbox date

    • value string nullable required

      The answer: a boolean for a checkbox, a number for a number field, otherwise text (a date as YYYY-MM-DD)

    • display string required

      The answer as readable text

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 POST request changes that data.