Polarex.CheckoutLinks (Polarex v0.2.0)
View SourceProvides API endpoints related to checkout links
Summary
Functions
Create Checkout Link
Delete Checkout Link
Get Checkout Link
List Checkout Links
Update Checkout Link
Functions
@spec checkout_links_create( Polarex.CheckoutLinkCreateProduct.t() | Polarex.CheckoutLinkCreateProductPrice.t() | Polarex.CheckoutLinkCreateProducts.t(), keyword() ) :: {:ok, Polarex.CheckoutLink.t()} | {:error, Polarex.HTTPValidationError.t()}
Create Checkout Link
Create a checkout link.
Scopes: checkout_links:write
@spec checkout_links_delete( String.t(), keyword() ) :: :ok | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Delete Checkout Link
Delete a checkout link.
Scopes: checkout_links:write
@spec checkout_links_get( String.t(), keyword() ) :: {:ok, Polarex.CheckoutLink.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Get Checkout Link
Get a checkout link by ID.
Scopes: checkout_links:read
checkout_links:write
@spec checkout_links_list(keyword()) :: {:ok, Polarex.ListResourceCheckoutLink.t()} | {:error, Polarex.HTTPValidationError.t()}
List Checkout Links
List checkout links.
Scopes: checkout_links:read
checkout_links:write
Options
organization_id
: Filter by organization ID.product_id
: Filter by product ID.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 checkout_links_update(String.t(), Polarex.CheckoutLinkUpdate.t(), keyword()) :: {:ok, Polarex.CheckoutLink.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.ResourceNotFound.t()}
Update Checkout Link
Update a checkout link.
Scopes: checkout_links:write