Striped v0.5.0

View Source Stripe.ApplePayDomain (Striped v0.5.0) (generated)

Link to this section Summary

Types

t()

The apple_pay_domain type.

Functions

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

Create an apple pay domain.

delete(client, domain, opts \\ [])

Delete an apple pay domain.

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

List apple pay domains.

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

Retrieve an apple pay domain.

Link to this section Types

Link to this type

t()

View Source 
@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 \\ %{}, opts \\ [])

View Source 
@spec create(
  client :: Stripe.t(),
  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
Link to this function

delete(client, domain, opts \\ [])

View Source 
@spec delete(client :: Stripe.t(), 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}
Link to this function

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

View Source 
@spec list(
  client :: Stripe.t(),
  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
Link to this function

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

View Source 
@spec retrieve(
  client :: Stripe.t(),
  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}