Polarex.Refunds (Polarex v0.3.0)
View SourceProvides API endpoints related to refunds
Summary
Functions
@spec refunds_create(body :: Polarex.RefundCreate.t(), opts :: keyword()) :: {:ok, Polarex.Refund.t()} | {:error, Polarex.HTTPValidationError.t() | Polarex.RefundedAlready.t()}
Create Refund
Create a refund.
Scopes: refunds:write
Request Body
Content Types: application/json
@spec refunds_list(opts :: keyword()) :: {:ok, Polarex.ListResourceRefund.t()} | {:error, Polarex.HTTPValidationError.t()}
List Refunds
List refunds.
Scopes: refunds:read refunds:write
Options
id: Filter by refund ID.organization_id: Filter by organization ID.order_id: Filter by order ID.subscription_id: Filter by subscription ID.customer_id: Filter by customer ID.external_customer_id: Filter by customer external ID.succeeded: Filter bysucceeded.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.