Paypal.Subscription.Plan.Info (Paypal v0.2.0)

Copy Markdown View Source

Plan details retrieved from the PayPal Billing Plans API.

Official PayPal API Documentation: PayPal Billing Plans API

Summary

Types

t()

Billing plan details

Types

t()

@type t() :: %Paypal.Subscription.Plan.Info{
  billing_cycles: [Paypal.Subscription.Plan.BillingCycle.t()],
  create_time: DateTime.t() | nil,
  description: String.t() | nil,
  id: String.t() | nil,
  links: [Paypal.Common.Link.t()],
  name: String.t() | nil,
  payment_preferences: Paypal.Subscription.Plan.PaymentPreferences.t() | nil,
  product_id: String.t() | nil,
  quantity_supported: boolean() | nil,
  status: any() | nil,
  taxes: Paypal.Subscription.Plan.Taxes.t() | nil,
  update_time: DateTime.t() | nil,
  usage_type: String.t() | nil
}

Billing plan details:

  • id - The unique plan ID (e.g. P-5ML4271244454362WXNWU5NQ).
  • product_id - The ID of the catalog product.
  • name - The plan name.
  • status - The plan status (:created, :inactive, :active).
  • description - Description of the plan.
  • usage_type - Usage type (e.g. "LICENSED").
  • billing_cycles - List of billing cycles configured.
  • payment_preferences - Payment preferences.
  • taxes - Tax settings.
  • quantity_supported - Whether the plan supports quantity.
  • create_time - Date and time when the plan was created.
  • update_time - Date and time when the plan was last updated.
  • links - HATEOAS links.