Polarex.BenefitGrants (Polarex v0.2.1)

View Source

Provides API endpoints related to benefit grants

Summary

Functions

customer_portal_benefit_grants_get(id, opts \\ [])

Get Benefit Grant

Get a benefit grant by ID for the authenticated customer.

Scopes: customer_portal:read customer_portal:write

customer_portal_benefit_grants_list(opts \\ [])

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

List Benefit Grants

List benefits grants of the authenticated customer.

Scopes: customer_portal:read customer_portal:write

Options

  • type: Filter by benefit type.
  • benefit_id: Filter by benefit ID.
  • organization_id: Filter by organization ID.
  • checkout_id: Filter by checkout ID.
  • order_id: Filter by order ID.
  • subscription_id: Filter by subscription 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.

customer_portal_benefit_grants_update(id, body, opts \\ [])

Update Benefit Grant

Update a benefit grant for the authenticated customer.

Scopes: customer_portal:write