Skip to content

Latest commit

 

History

History
50 lines (44 loc) · 5.12 KB

SubscriptionObject.md

File metadata and controls

50 lines (44 loc) · 5.12 KB
Raw

LagoAPI::SubscriptionObject

Properties

Name Type Description Notes
lago_id String Unique identifier assigned to the subscription within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the subscription’s record within the Lago system
external_id String The subscription external unique identifier (provided by your own application).
lago_customer_id String Unique identifier assigned to the customer within the Lago application. This ID is exclusively created by Lago and serves as a unique identifier for the customer's record within the Lago system
external_customer_id String The customer external unique identifier (provided by your own application).
billing_time String The billing time for the subscription, which can be set as either `anniversary` or `calendar`. If not explicitly provided, it will default to `calendar`. The billing time determines the timing of recurring billing cycles for the subscription. By specifying `anniversary`, the billing cycle will be based on the specific date the subscription started (billed fully), while `calendar` sets the billing cycle at the first day of the week/month/year (billed with proration).
name String The display name of the subscription on an invoice. This field allows for customization of the subscription's name for billing purposes, especially useful when a single customer has multiple subscriptions using the same plan. [optional]
plan_code String The unique code representing the plan to be attached to the customer. This code must correspond to the `code` property of one of the active plans.
status String The status of the subscription, which can have the following values: - `pending`: a previous subscription has been downgraded, and the current one is awaiting automatic activation at the end of the billing period. - `active`: the subscription is currently active and applied to the customer. - `terminated`: the subscription is no longer active. - `canceled`: the subscription has been stopped before its activation. This can occur when two consecutive downgrades have been applied to a customer or when a subscription with a pending status is terminated.
created_at Time The creation date of the subscription, represented in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). This date provides a timestamp indicating when the subscription was initially created.
canceled_at Time The cancellation date of the subscription. This field is not null when the subscription is `canceled`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). [optional]
started_at Time The effective start date of the subscription. This field can be null if the subscription is `pending` or `canceled`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC). [optional]
ending_at Time The effective end date of the subscription. If this field is set to null, the subscription will automatically renew. This date should be provided in ISO 8601 datetime format, and use Coordinated Universal Time (UTC). [optional]
subscription_at Time The anniversary date and time of the initial subscription. This date serves as the basis for billing subscriptions with `anniversary` billing time. The `anniversary_date` should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC).
terminated_at Time The termination date of the subscription. This field is not null when the subscription is `terminated`. This date should be provided in ISO 8601 datetime format and expressed in Coordinated Universal Time (UTC) [optional]
previous_plan_code String The code identifying the previous plan associated with this subscription. [optional]
next_plan_code String The code identifying the next plan in the case of a downgrade. [optional]
downgrade_plan_date Time The date when the plan will be downgraded, represented in ISO 8601 date format. [optional]

Example

require 'lago_ruby'

instance = LagoAPI::SubscriptionObject.new(
  lago_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
  external_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
  lago_customer_id: 1a901a90-1a90-1a90-1a90-1a901a901a90,
  external_customer_id: 5eb02857-a71e-4ea2-bcf9-57d3a41bc6ba,
  billing_time: anniversary,
  name: Repository A,
  plan_code: premium,
  status: active,
  created_at: 2022-08-08T00:00Z,
  canceled_at: 2022-09-14T16:35:31Z,
  started_at: 2022-08-08T00:00Z,
  ending_at: 2022-10-08T00:00Z,
  subscription_at: 2022-08-08T00:00Z,
  terminated_at: 2022-09-14T16:35:31Z,
  previous_plan_code: null,
  next_plan_code: null,
  downgrade_plan_date: null
)