stripity_stripe

v2.0.0-alpha.6

stripity_stripe v2.0.0-alpha.6 Stripe.APIErrorResponse

Represents an error response from the API

See the type documentation for more about how this struct can be used.

The full details of error responses can be found in the Stripe API documentation.

Summary

Types

t()

The code, status_code, and type fields can all be used for control flow. The message field should only be used for understanding what went wrong, and you should not expose it to the end-user unless you are sure it does not contain sensitive information based on the type field

Functions

new(arg)

Types

t() 
t :: %Stripe.APIErrorResponse{code: String.t | nil, message: String.t | nil, status_code: pos_integer | nil, type: String.t | nil}

The code, status_code, and type fields can all be used for control flow. The message field should only be used for understanding what went wrong, and you should not expose it to the end-user unless you are sure it does not contain sensitive information based on the type field.

code

A short, parsable code provided when there there was a card error in order to describe the error furhter.

message

A human readable message describing the error, if one was provided.

status_code

The HTTP status code that was returned with the error.

type

Stripe’s error type

Functions

new(arg) 
new({integer, map}) :: t