Documentation

Fields

• subscriptionAccount :: Maybe AccountMini

  account

• subscriptionAction_result :: Maybe Object

  action_result: Action result params to be used in Recurly-JS to complete a payment when using asynchronous payment methods, e.g., Boleto, iDEAL and Sofort.

• subscriptionActivated_at :: Maybe JsonDateTime

  activated_at

• subscriptionActive_invoice_id :: Maybe Text

  active_invoice_id: The invoice ID of the latest invoice created for an active subscription.

  Constraints:

  • Maximum length of 13
• subscriptionAdd_ons :: Maybe [SubscriptionAddOn]

  add_ons

• subscriptionAdd_ons_total :: Maybe Float

  add_ons_total

  Constraints:

  • Minimum of 0.0
• subscriptionAuto_renew :: Maybe Bool

  auto_renew: Whether the subscription renews at the end of its term.

• subscriptionBank_account_authorized_at :: Maybe JsonDateTime

  bank_account_authorized_at: Recurring subscriptions paid with ACH will have this attribute set. This timestamp is used for alerting customers to reauthorize in 3 years in accordance with NACHA rules. If a subscription becomes inactive or the billing info is no longer a bank account, this timestamp is cleared.

• subscriptionBilling_info_id :: Maybe Text

  billing_info_id: Billing Info ID.

• subscriptionBusiness_entity_id :: Maybe Text

  business_entity_id: The ID of the business entity associated with the subscription. This will be `null` if the subscription relies on resolving the business entity during renewal.

  Constraints:

  • Maximum length of 13
• subscriptionCanceled_at :: Maybe JsonDateTime

  canceled_at

• subscriptionCollection_method :: Maybe SubscriptionCollection_method

  collection_method

• subscriptionConverted_at :: Maybe JsonDateTime

  converted_at: When the subscription was converted from a gift card.

• subscriptionCoupon_redemptions :: Maybe [CouponRedemptionMini]

  coupon_redemptions: Returns subscription level coupon redemptions that are tied to this subscription.

• subscriptionCreated_at :: Maybe JsonDateTime

  created_at

• subscriptionCurrency :: Maybe Text

  currency: 3-letter ISO 4217 currency code.

  Constraints:

  • Maximum length of 3
• subscriptionCurrent_period_ends_at :: Maybe JsonDateTime

  current_period_ends_at

• subscriptionCurrent_period_started_at :: Maybe JsonDateTime

  current_period_started_at

• subscriptionCurrent_term_ends_at :: Maybe JsonDateTime

  current_term_ends_at: When the term ends. This is calculated by a plan's interval and `total_billing_cycles` in a term. Subscription changes with a `timeframe=renewal` will be applied on this date.

• subscriptionCurrent_term_started_at :: Maybe JsonDateTime

  current_term_started_at: The start date of the term when the first billing period starts. The subscription term is the length of time that a customer will be committed to a subscription. A term can span multiple billing periods.

• subscriptionCustom_fields :: Maybe CustomFields

  custom_fields: The custom fields will only be altered when they are included in a request. Sending an empty array will not remove any existing values. To remove a field send the name with a null or empty value.

• subscriptionCustomer_notes :: Maybe Text

  customer_notes

• subscriptionExpiration_reason :: Maybe Text

  expiration_reason

• subscriptionExpires_at :: Maybe JsonDateTime

  expires_at

• subscriptionGateway_code :: Maybe Text

  gateway_code: If present, this subscription's transactions will use the payment gateway with this code.

  Constraints:

  • Maximum length of 13
• subscriptionId :: Maybe Text

  id

  Constraints:

  • Maximum length of 13
• subscriptionNet_terms :: Maybe Int

  net_terms: Integer paired with `Net Terms Type` and representing the number of days past the current date (for `net` Net Terms Type) or days after the last day of the current month (for `eom` Net Terms Type) that the invoice will become past due. For `manual` collection method, an additional 24 hours is added to ensure the customer has the entire last day to make payment before becoming past due. For example:

  If an invoice is due `net 0`, it is due 'On Receipt' and will become past due 24 hours after it's created. If an invoice is due `net 30`, it will become past due at 31 days exactly. If an invoice is due `eom 30`, it will become past due 31 days from the last day of the current month.

  For `automatic` collection method, the additional 24 hours is not added. For example, On-Receipt is due immediately, and `net 30` will become due exactly 30 days from invoice generation, at which point Recurly will attempt collection. When `eom` Net Terms Type is passed, the value for `Net Terms` is restricted to `0, 15, 30, 45, 60, or 90`.

  For more information on how net terms work with `manual` collection visit our docs page (https://docs.recurly.com/docs/manual-payments#section-collection-terms) or visit (https://docs.recurly.com/docs/automatic-invoicing-terms#section-collection-terms) for information about net terms using `automatic` collection.

  Constraints:

  • Minimum of 0.0
• subscriptionNet_terms_type :: Maybe SubscriptionNet_terms_type

  net_terms_type: Optionally supplied string that may be either `net` or `eom` (end-of-month). When `net`, an invoice becomes past due the specified number of `Net Terms` days from the current date. When `eom` an invoice becomes past due the specified number of `Net Terms` days from the last day of the current month.

• subscriptionObject :: Maybe Text

  object

• subscriptionPaused_at :: Maybe JsonDateTime

  paused_at: Null unless subscription is paused or will pause at the end of the current billing period.

• subscriptionPending_change :: Maybe SubscriptionChange

  pending_change

• subscriptionPlan :: Maybe PlanMini

  plan: Just the important parts.

• subscriptionPo_number :: Maybe Text

  po_number: For manual invoicing, this identifies the PO number associated with the subscription.

  Constraints:

  • Maximum length of 50
• subscriptionQuantity :: Maybe Int

  quantity

  Constraints:

  • Minimum of 0.0
• subscriptionRamp_intervals :: Maybe [SubscriptionRampIntervalResponse]

  ramp_intervals: The ramp intervals representing the pricing schedule for the subscription.

• subscriptionRemaining_billing_cycles :: Maybe Int

  remaining_billing_cycles: The remaining billing cycles in the current term.

• subscriptionRemaining_pause_cycles :: Maybe Int

  remaining_pause_cycles: Null unless subscription is paused or will pause at the end of the current billing period.

• subscriptionRenewal_billing_cycles :: Maybe Int

  renewal_billing_cycles: If `auto_renew=true`, when a term completes, `total_billing_cycles` takes this value as the length of subsequent terms. Defaults to the plan's `total_billing_cycles`.

• subscriptionRevenue_schedule_type :: Maybe SubscriptionRevenue_schedule_type

  revenue_schedule_type

• subscriptionShipping :: Maybe SubscriptionShipping

  shipping

• subscriptionStarted_with_gift :: Maybe Bool

  started_with_gift: Whether the subscription was started with a gift certificate.

• subscriptionState :: Maybe SubscriptionState

  state

• subscriptionSubtotal :: Maybe Float

  subtotal

  Constraints:

  • Minimum of 0.0
• subscriptionTax :: Maybe Float

  tax: Only for merchants using Recurly's In-The-Box taxes.

• subscriptionTax_inclusive :: Maybe Bool

  tax_inclusive: Determines whether or not tax is included in the unit amount. The Tax Inclusive Pricing feature (separate from the Mixed Tax Pricing feature) must be enabled to utilize this flag.

• subscriptionTax_info :: Maybe TaxInfo

  tax_info: Only for merchants using Recurly's In-The-Box taxes.

• subscriptionTerms_and_conditions :: Maybe Text

  terms_and_conditions

• subscriptionTotal :: Maybe Float

  total

• subscriptionTotal_billing_cycles :: Maybe Int

  total_billing_cycles: The number of cycles/billing periods in a term. When `remaining_billing_cycles=0`, if `auto_renew=true` the subscription will renew and a new term will begin, otherwise the subscription will expire.

• subscriptionTrial_ends_at :: Maybe JsonDateTime

  trial_ends_at

• subscriptionTrial_started_at :: Maybe JsonDateTime

  trial_started_at

• subscriptionUnit_amount :: Maybe Float

  unit_amount

• subscriptionUpdated_at :: Maybe JsonDateTime

  updated_at

• subscriptionUuid :: Maybe Text

  uuid: The UUID is useful for matching data with the CSV exports and building URLs into Recurly's UI.

  Constraints:

  • Maximum length of 32