Paypal.Subscription.Info (Paypal v0.2.0)

Copy Markdown View Source

Subscription information retrieved from the PayPal Subscriptions API.

Official PayPal API Documentation: Show Subscription Details

Summary

Types

t()

Subscription details

Types

t()

@type t() :: %Paypal.Subscription.Info{
  billing_info: Paypal.Subscription.BillingInfo.t() | nil,
  create_time: DateTime.t() | nil,
  custom_id: String.t() | nil,
  id: String.t() | nil,
  links: [Paypal.Common.Link.t()],
  plan: Paypal.Subscription.Plan.Info.t() | nil,
  plan_id: String.t() | nil,
  plan_overridden: boolean() | nil,
  quantity: String.t() | nil,
  shipping_amount: Paypal.Common.CurrencyValue.t() | nil,
  start_time: DateTime.t() | nil,
  status: any() | nil,
  status_change_note: String.t() | nil,
  status_update_time: DateTime.t() | nil,
  subscriber: Paypal.Subscription.Subscriber.t() | nil,
  update_time: DateTime.t() | nil
}

Subscription details:

  • id - The unique subscription ID (e.g. I-BW452GLLEP1G).
  • plan_id - The ID of the billing plan.
  • start_time - Date and time when the subscription starts.
  • quantity - The subscription quantity.
  • shipping_amount - The shipping amount for the subscription.
  • subscriber - Information about the subscriber.
  • billing_info - Billing details and cycle executions.
  • create_time - Date and time when the subscription was created.
  • update_time - Date and time when the subscription was last updated.
  • custom_id - Custom ID provided by the API caller.
  • plan_overridden - Whether the plan was overridden.
  • plan - Embedded plan details if requested with ?fields=plan.
  • status - The subscription status (:approval_pending, :approved, :active, :suspended, :cancelled, :expired).
  • status_change_note - Note explaining reason for last status change.
  • status_update_time - Date and time of last status change.
  • links - HATEOAS links.