Polarex.Refunds (Polarex v0.2.1)

View Source

Provides API endpoints related to refunds

Summary

Functions

refunds_create(body, opts \\ [])

Create Refund

Create a refund.

Scopes: refunds:write

refunds_list(opts \\ [])

@spec refunds_list(keyword()) ::
  {:ok, Polarex.ListResourceRefund.t()}
  | {:error, Polarex.HTTPValidationError.t()}

List Refunds

List products.

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.
  • succeeded: Filter by succeeded.
  • 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.