Polarex.Checkouts (Polarex v0.2.0)
View SourceProvides API endpoints related to checkouts
Summary
Functions
Confirm Checkout Session from Client
Get Checkout Session from Client
Update Checkout Session from Client
Create Checkout Session
Get Checkout Session
List Checkout Sessions
Update Checkout Session
Functions
@spec checkouts_client_confirm( String.t(), Polarex.CheckoutConfirmStripe.t(), keyword() ) :: {:ok, Polarex.CheckoutPublicConfirmed.t()} | {:error, Polarex.AlreadyActiveSubscriptionError.t() | Polarex.ExpiredCheckoutError.t() | Polarex.HTTPValidationError.t() | Polarex.NotOpenCheckout.t() | Polarex.PaymentError.t() | Polarex.ResourceNotFound.t()}
Confirm Checkout Session from Client
Confirm a checkout session by client secret.
Orders and subscriptions will be processed.
@spec checkouts_client_get( String.t(), keyword() ) :: {:ok, Polarex.CheckoutPublic.t()} | {:error, Polarex.ExpiredCheckoutError.t() | Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Get Checkout Session from Client
Get a checkout session by client secret.
@spec checkouts_client_update(String.t(), Polarex.CheckoutUpdatePublic.t(), keyword()) :: {:ok, Polarex.CheckoutPublic.t()} | {:error, Polarex.AlreadyActiveSubscriptionError.t() | Polarex.ExpiredCheckoutError.t() | Polarex.HTTPValidationError.t() | Polarex.NotOpenCheckout.t() | Polarex.ResourceNotFound.t()}
Update Checkout Session from Client
Update a checkout session by client secret.
@spec checkouts_create( Polarex.CheckoutProductsCreate.t(), keyword() ) :: {:ok, Polarex.Checkout.t()} | {:error, Polarex.HTTPValidationError.t()}
Create Checkout Session
Create a checkout session.
Scopes: checkouts:write
@spec checkouts_get( String.t(), keyword() ) :: {:ok, Polarex.Checkout.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Get Checkout Session
Get a checkout session by ID.
Scopes: checkouts:read
checkouts:write
@spec checkouts_list(keyword()) :: {:ok, Polarex.ListResourceCheckout.t()} | {:error, Polarex.HTTPValidationError.t()}
List Checkout Sessions
List checkout sessions.
Scopes: checkouts:read
checkouts:write
Options
organization_id
: Filter by organization ID.product_id
: Filter by product ID.customer_id
: Filter by customer ID.status
: Filter by checkout session status.query
: Filter by customer email.page
: Page number, defaults to 1.limit
: Size of a page, defaults to 10. Maximum is 100.sorting
: Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign-
before the criteria name to sort by descending order.
@spec checkouts_update(String.t(), Polarex.CheckoutUpdate.t(), keyword()) :: {:ok, Polarex.Checkout.t()} | {:error, Polarex.AlreadyActiveSubscriptionError.t() | Polarex.HTTPValidationError.t() | Polarex.NotOpenCheckout.t() | Polarex.ResourceNotFound.t()}
Update Checkout Session
Update a checkout session.
Scopes: checkouts:write