Braintree.Plan (Braintree v0.12.0)

Plans represent recurring billing plans in a Braintree merchant account. The API for plans is read only.

For additional reference see: https://developers.braintreepayments.com/reference/request/plan/all/ruby

Link to this section Summary

Types

t()

Functions

all(opts \\ [])

Get a list of all the plans defined in the merchant account. If there are no plans an empty list is returned.

new(params)

Link to this section Types

t()

Specs

t() :: %Braintree.Plan{
  add_ons: [any()],
  balance: String.t(),
  billing_day_of_month: String.t(),
  billing_frequency: String.t(),
  created_at: String.t(),
  currency_iso_code: String.t(),
  description: String.t(),
  discounts: [any()],
  id: String.t(),
  name: String.t(),
  number_of_billing_cycles: String.t(),
  price: String.t(),
  trial_duration: String.t(),
  trial_duration_unit: String.t(),
  trial_period: String.t(),
  updated_at: String.t()
}

Link to this section Functions

all(opts \\ [])

Specs

all(Keyword.t()) :: {:ok, [t()]} | {:error, Braintree.ErrorResponse.t()}

Get a list of all the plans defined in the merchant account. If there are no plans an empty list is returned.

Example

{:ok, plans} = Braintree.Plan.all()