stripity_stripe v2.7.0 Stripe.CreditNote View Source
Work with Stripe Credit Note objects.
You can:
- Create a credit note
- Retrieve a credit note
- Update a credit note
- Void a credit note
- List credit notes
{
"id": "ivory-extended-580",
"object": "plan",
"active": true,
"aggregate_usage": null,
"amount": 999,
"billing_scheme": "per_unit",
"created": 1531234812,
"currency": "usd",
"interval": "month",
"interval_count": 1,
"livemode": false,
"metadata": {
},
"nickname": null,
"product": "prod_DCmtkptv7qHXGE",
"tiers": null,
"tiers_mode": null,
"transform_usage": null,
"trial_period_days": null,
"usage_type": "licensed"
}Link to this section Summary
Functions
Create a credit note.
List all credit notes.
Retrieve a Credit Note.
Update a credit note.
Void a credit note.
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %Stripe.CreditNote{
amount: integer(),
created: Stripe.timestamp(),
currency: String.t(),
customer: Stripe.id() | nil,
id: Stripe.id(),
invoice: Stripe.id(),
livemode: boolean(),
memo: term(),
metadata: Stripe.Types.metadata(),
number: String.t(),
object: String.t(),
pdf: String.t(),
reason: String.t() | nil,
refund: Stripe.id() | Stripe.Refund.t() | nil,
status: String.t(),
type: String.t()
}
t() :: %Stripe.CreditNote{
amount: integer(),
created: Stripe.timestamp(),
currency: String.t(),
customer: Stripe.id() | nil,
id: Stripe.id(),
invoice: Stripe.id(),
livemode: boolean(),
memo: term(),
metadata: Stripe.Types.metadata(),
number: String.t(),
object: String.t(),
pdf: String.t(),
reason: String.t() | nil,
refund: Stripe.id() | Stripe.Refund.t() | nil,
status: String.t(),
type: String.t()
}
Link to this section Functions
Link to this function
create(params, opts \\ [])
View Source
create(params, opts \\ [])
View Source
create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
when params:
%{
:amount => number(),
:invoice => Stripe.id(),
optional(:credit_amount) => number(),
optional(:memo) => String.t(),
optional(:metadata) => Stripe.Types.metadata(),
optional(:reason) => String.t(),
optional(:refund_amount) => number(),
optional(:refund) => Stripe.id()
}
| %{}
create(params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{ :amount => number(), :invoice => Stripe.id(), optional(:credit_amount) => number(), optional(:memo) => String.t(), optional(:metadata) => Stripe.Types.metadata(), optional(:reason) => String.t(), optional(:refund_amount) => number(), optional(:refund) => Stripe.id() } | %{}
Create a credit note.
Stripe.CreditNote.create(%{
invoice: "in_173uNd4Wq104wst7Gf4dgq1Y",
amount: 500,})
Link to this function
list(params \\ %{}, opts \\ [])
View Source
list(params \\ %{}, opts \\ [])
View Source
list(params, Stripe.options()) ::
{:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()}
when params:
%{
optional(:ending_before) => t() | Stripe.id(),
optional(:limit) => 1..100,
optional(:invoice) => Stripe.id(),
optional(:starting_after) => t() | Stripe.id()
}
| %{}
list(params, Stripe.options()) :: {:ok, Stripe.List.t(t())} | {:error, Stripe.Error.t()} when params: %{ optional(:ending_before) => t() | Stripe.id(), optional(:limit) => 1..100, optional(:invoice) => Stripe.id(), optional(:starting_after) => t() | Stripe.id() } | %{}
List all credit notes.
Stripe.CreditNote.list(limit: 3)
Link to this function
retrieve(id, opts \\ [])
View Source
retrieve(id, opts \\ [])
View Source
retrieve(Stripe.id() | t(), Stripe.options()) ::
{:ok, t()} | {:error, Stripe.Error.t()}
retrieve(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Retrieve a Credit Note.
Stripe.CreditNote.retrieve("cn_1EXwJk4Wq104wst7IISdh9ed")
Link to this function
update(id, params, opts \\ [])
View Source
update(id, params, opts \\ [])
View Source
update(Stripe.id() | t(), params, Stripe.options()) ::
{:ok, t()} | {:error, Stripe.Error.t()}
when params:
%{
optional(:memo) => String.t(),
optional(:metadata) => Stripe.Types.metadata()
}
| %{}
update(Stripe.id() | t(), params, Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()} when params: %{ optional(:memo) => String.t(), optional(:metadata) => Stripe.Types.metadata() } | %{}
Update a credit note.
Takes the id and a map of changes.
Stripe.CreditNote.update(
"cn_1EXwJk4Wq104wst7IISdh9ed",
%{
metadata: {order_id: "6735"},
})
Link to this function
void(id, opts \\ [])
View Source
void(id, opts \\ [])
View Source
void(Stripe.id() | t(), Stripe.options()) ::
{:ok, t()} | {:error, Stripe.Error.t()}
void(Stripe.id() | t(), Stripe.options()) :: {:ok, t()} | {:error, Stripe.Error.t()}
Void a credit note.
Stripe.CreditNote.void("cn_1EXwJk4Wq104wst7IISdh9ed")