StripeElixir.Services.Billing.CreditGrantService (stripe_elixir v0.1.0)

CreditGrant

A credit grant is an API resource that documents the allocation of some billing credits to a customer.

Summary

Create a credit grant

Expire a credit grant

List credit grants

Retrieve a credit grant

Update a credit grant

Void a credit grant

@spec create(StripeElixir.Client.t(), map(), keyword()) ::
  {:ok, term()} | {:error, StripeElixir.Error.t()}

Create a credit grant

Creates a credit grant.

@spec expire(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, StripeElixir.Error.t()}

Expire a credit grant

Expires a credit grant.

@spec list(StripeElixir.Client.t(), map(), keyword()) ::
  {:ok, term()} | {:error, StripeElixir.Error.t()}

List credit grants

Retrieve a list of credit grants.

@spec retrieve(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, StripeElixir.Error.t()}

Retrieve a credit grant

Retrieves a credit grant.

@spec update(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, StripeElixir.Error.t()}

Update a credit grant

Updates a credit grant.

@spec void_grant(StripeElixir.Client.t(), String.t(), map(), keyword()) ::
  {:ok, term()} | {:error, StripeElixir.Error.t()}

Void a credit grant

Voids a credit grant.