Search documentation of tiger_stripe

# Stripe.Services.Billing.CreditGrantService (tiger_stripe v0.1.1)

Copy Markdown View Source

CreditGrant

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

Related guide: Billing credits

## Summary

### Functions

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

Create a credit grant

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

Expire a credit grant

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

List credit grants

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

Retrieve a credit grant

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

Update a credit grant

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

Void a credit grant

## Functions

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

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

Create a credit grant

Creates a credit grant.

# expire(client, id, params \\ %{}, opts \\ [])

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

Expire a credit grant

Expires a credit grant.

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

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

List credit grants

Retrieve a list of credit grants.

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

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

Retrieve a credit grant

Retrieves a credit grant.

# update(client, id, params \\ %{}, opts \\ [])

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

Update a credit grant

Updates a credit grant.

# void_grant(client, id, params \\ %{}, opts \\ [])

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

Void a credit grant

Voids a credit grant.