View Source Stripe.ApplePayDomain (stripity_stripe v3.2.0)

Summary

Types

t()

The apple_pay_domain type.

Functions

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

Create an apple pay domain.

delete(domain, opts \\ [])

Delete an apple pay domain.

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

List apple pay domains.

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

Retrieve an apple pay domain.

Types

t()

@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.

Functions

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

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

Create an apple pay domain.

Details

Method: post
Path: /v1/apple_pay/domains

delete(domain, opts \\ [])

@spec delete(domain :: binary(), opts :: Keyword.t()) ::
  {:ok, Stripe.DeletedApplePayDomain.t()}
  | {:error, Stripe.ApiErrors.t()}
  | {:error, term()}

Delete an apple pay domain.

Details

Method: delete
Path: /v1/apple_pay/domains/{domain}

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

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

List apple pay domains.

Details

Method: get
Path: /v1/apple_pay/domains

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

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

Retrieve an apple pay domain.

Details

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