View Source Stripe.Issuing.PhysicalBundle (stripity_stripe v3.3.1)

A Physical Bundle represents the bundle of physical items - card stock, carrier letter, and envelope - that is shipped to a cardholder when you create a physical card.

Summary

Types

t()

The issuing.physical_bundle type.

Functions

list(params \\ %{}, opts \\ [])

Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

retrieve(physical_bundle, params \\ %{}, opts \\ [])

Retrieves a physical bundle object.

Types

t()

@type t() :: %Stripe.Issuing.PhysicalBundle{
  features: term(),
  id: binary(),
  livemode: boolean(),
  name: binary(),
  object: binary(),
  status: binary(),
  type: binary()
}

The issuing.physical_bundle type.

features
id Unique identifier for the object.
livemode Has the value true if the object exists in live mode or the value false if the object exists in test mode.
name Friendly display name.
object String representing the object's type. Objects of the same type share the same value.
status Whether this physical bundle can be used to create cards.
type Whether this physical bundle is a standard Stripe offering or custom-made for you.

Functions

list(params \\ %{}, opts \\ [])

@spec list(
  params :: %{
    optional(:ending_before) => binary(),
    optional(:expand) => [binary()],
    optional(:limit) => integer(),
    optional(:starting_after) => binary(),
    optional(:status) => :active | :inactive | :review,
    optional(:type) => :custom | :standard
  },
  opts :: Keyword.t()
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Returns a list of physical bundle objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Details

Method: get
Path: /v1/issuing/physical_bundles

retrieve(physical_bundle, params \\ %{}, opts \\ [])

@spec retrieve(
  physical_bundle :: binary(),
  params :: %{optional(:expand) => [binary()]},
  opts :: Keyword.t()
) :: {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieves a physical bundle object.

Details

Method: get
Path: /v1/issuing/physical_bundles/{physical_bundle}