livery_stripe_promotion_code (livery_stripe v0.1.0)

View Source

Stripe Promotion Codes API (customer-facing codes mapping to a coupon).

Summary

Functions

Create a promotion code (Params requires coupon; optional code).

Like create/2 with request options (idempotency_key, etc.).

Update a promotion code (e.g. active => false to deactivate).

Functions

create(Client, Params)

-spec create(livery_client:client(), map() | list()) -> {ok, map()} | {error, term()}.

Create a promotion code (Params requires coupon; optional code).

create(Client, Params, Opts)

-spec create(livery_client:client(), map() | list(), map()) -> {ok, map()} | {error, term()}.

Like create/2 with request options (idempotency_key, etc.).

list(Client)

-spec list(livery_client:client()) -> {ok, map()} | {error, term()}.

list(Client, Params)

-spec list(livery_client:client(), map() | list()) -> {ok, map()} | {error, term()}.

retrieve(Client, Id)

-spec retrieve(livery_client:client(), binary()) -> {ok, map()} | {error, term()}.

update(Client, Id, Params)

-spec update(livery_client:client(), binary(), map() | list()) -> {ok, map()} | {error, term()}.

Update a promotion code (e.g. active => false to deactivate).