View Source Stripe.ApplePayDomain (Striped v0.2.0)

Link to this section Summary

Types

t()

The apple_pay_domain type.

Functions

Create an apple pay domain.

Delete an apple pay domain.

List apple pay domains.

Retrieve an apple pay domain.

Link to this section Types

@type t() :: %Stripe.ApplePayDomain{
  created: integer(),
  domain_name: binary(),
  id: binary(),
  livemode: boolean(),
  object: binary()
}

The apple_pay_domain type.

  • created Time at which the object was created. Measured in seconds since the Unix epoch.
  • domain_name
  • 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.
  • object String representing the object's type. Objects of the same type share the same value.

Link to this section Functions

Link to this function

create(client, params \\ %{})

View Source
@spec create(
  client :: term(),
  params :: %{:domain_name => :string, optional(:expand) => [:string]}
) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Create an apple pay domain.

Details

  • Method: post
  • Path: /v1/apple_pay/domains
@spec delete(client :: term(), domain :: binary()) ::
  {:ok, Stripe.DeletedApplePayDomain.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Delete an apple pay domain.

Details

  • Method: delete
  • Path: /v1/apple_pay/domains/{domain}
Link to this function

list(client, params \\ %{})

View Source
@spec list(
  client :: term(),
  params :: %{
    optional(:domain_name) => :string,
    optional(:ending_before) => :string,
    optional(:expand) => [:string],
    optional(:limit) => :integer,
    optional(:starting_after) => :string
  }
) ::
  {:ok, Stripe.List.t(t())} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

List apple pay domains.

Details

  • Method: get
  • Path: /v1/apple_pay/domains
Link to this function

retrieve(client, domain, params \\ %{})

View Source
@spec retrieve(
  client :: term(),
  domain :: binary(),
  params :: %{optional(:expand) => [:string]}
) ::
  {:ok, t()} | {:error, Stripe.ApiErrors.t()} | {:error, term()}

Retrieve an apple pay domain.

Details

  • Method: get
  • Path: /v1/apple_pay/domains/{domain}