Objects

The Subscription object

Fields of the Subscription object.

Attributes

• 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