---
title: "Get payment settings"
description: "Read the payment configuration for a preorder offer."
url: https://docs.stoqapp.com/v2-reference/preorders-offers/get-payment-settings/
api: "API v2 reference"
method: GET
path: "/preorders/offers/{id}/payments"
---

# Get payment settings

`GET https://app.stoqapp.com/api/v2/external/preorders/offers/{id}/payments`

Read the payment configuration for a preorder offer.

**Note:** `full` and `partial` appear only for the kinds in `options_offered`; each is its own Shopify selling plan (`selling_plan_id`) the shopper picks, and `default_option` is selected by default. A full option always charges 100% at checkout. A partial balance is charged on its `remaining_balance` date or day count only when `collection_schedule` is `scheduled`; `on_fulfillment` charges it at fulfillment and `manual` leaves it to the merchant. Fixed amounts are in `currency_code`, the shop's currency. Edit with [`PATCH /preorders/offers/:id/payments`](https://docs.stoqapp.com/v2-reference/preorders-offers/update-payment-settings/).

## Path parameters

- `id` (string, required): The offer's ID, from [`GET /preorders/offers`](https://docs.stoqapp.com/v2-reference/preorders-offers/list-offers/).

## Query parameters

- `locale` (string): Language for translated text, such as fr or pt-BR. Omit for the shop's default language.

## Returns

- `options_offered` (string): Payment options the offer has. One of: `full`, `partial`, `full_and_partial`.
- `default_option` (string): Payment option selected by default at checkout. One of: `full`, `partial`.
- `full` (object): The full-payment option, where shoppers pay everything at checkout. Absent when the offer has no full-payment option.
  - `selling_plan_id` (string): This option's Shopify selling plan, as gid://shopify/SellingPlan/&lt;id&gt;. Null until it exists in Shopify.
  - `checkout_charge` (object): What is charged at checkout. Always 100 percent for full payment.
    - `charge_type` (string): Always percentage for full payment. One of: `percentage`, `price`.
    - `charge_amount` (integer): Always 100 for full payment.
  - `remaining_balance` (object): When the remaining balance is charged. Nothing remains on full payment.
    - `charge_trigger` (string): Always no_remaining_balance for full payment. One of: `exact_time`, `no_remaining_balance`, `time_after_checkout`.
    - `charge_exact_time` (null): Always null for full payment.
    - `days_after_checkout` (null): Always null for full payment.
  - `price_adjustment` (object): Discount on this option's price.
    - `adjustment_type` (string): percentage takes adjustment_amount percent off; fixed_amount and price take adjustment_amount off in the shop's currency. Null when there is no discount. One of: `percentage`, `price`, `fixed_amount`.
    - `adjustment_amount` (integer): Discount size: a percent, or an amount in the shop's currency (not minor units), per adjustment_type. Null when there is no discount.
  - `option_title` (string): Title of the full-payment option in the payment widget.
  - `option_description` (string): Description of the full-payment option in the payment widget. Null when not set.
  - `discount_text` (string): Text describing the full-payment discount.
- `partial` (object): The partial-payment option, where shoppers pay a deposit at checkout and the balance later. Absent when the offer has no partial-payment option.
  - `selling_plan_id` (string): This option's Shopify selling plan, as gid://shopify/SellingPlan/&lt;id&gt;. Null until it exists in Shopify.
  - `checkout_charge` (object): The deposit charged at checkout.
    - `charge_type` (string): percentage charges charge_amount percent of the price; price charges charge_amount in the shop's currency. One of: `percentage`, `price`.
    - `charge_amount` (integer): The deposit: a percent from 0 to 100 when charge_type is percentage, or an amount in the shop's currency (not minor units) when it is price. 0 charges nothing at checkout.
  - `remaining_balance` (object): When the remaining balance is charged.
    - `charge_trigger` (string): exact_time charges the balance on charge_exact_time; time_after_checkout charges it days_after_checkout days after checkout. One of: `exact_time`, `no_remaining_balance`, `time_after_checkout`.
    - `charge_exact_time` (null): When the balance is due, ISO 8601 in UTC. Null unless charge_trigger is exact_time.
    - `days_after_checkout` (integer): Days after checkout that the balance is due. Null unless charge_trigger is time_after_checkout.
  - `price_adjustment` (object): Discount on this option's price.
    - `adjustment_type` (null): percentage takes adjustment_amount percent off; fixed_amount and price take adjustment_amount off in the shop's currency. Null when there is no discount. One of: `percentage`, `price`, `fixed_amount`.
    - `adjustment_amount` (null): Discount size: a percent, or an amount in the shop's currency (not minor units), per adjustment_type. Null when there is no discount.
  - `option_title` (string): Title of the partial-payment option in the payment widget.
  - `option_description` (string): Description of the partial-payment option in the payment widget. Null when not set.
  - `discount_text` (string): Text describing the partial-payment discount.
- `collection_schedule` (string): How the remaining balance is collected: manual by the merchant, scheduled on its due date, or on_fulfillment. One of: `manual`, `scheduled`, `on_fulfillment`.
- `show_payment_widget` (boolean): Whether the payment and discount savings widget shows on the product page.
- `show_discounted_price` (null): Whether the discounted price shows. Null when never set.
- `currency_code` (null): The shop's currency, as an ISO 4217 code such as USD. Amounts in this section are in it.

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Examples

### Get payment settings

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/payments" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

### Get payment settings filtered by locale

```sh
curl "https://app.stoqapp.com/api/v2/external/preorders/offers/73a74948-2b57-4cc3-971f-2b441828c977/payments?locale=fr" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

```json
{
  "options_offered": "full",
  "default_option": "full",
  "full": {
    "selling_plan_id": "string",
    "checkout_charge": {
      "charge_type": "percentage",
      "charge_amount": 1
    },
    "remaining_balance": {
      "charge_trigger": "exact_time",
      "charge_exact_time": null,
      "days_after_checkout": null
    },
    "price_adjustment": {
      "adjustment_type": "percentage",
      "adjustment_amount": 1
    },
    "option_title": "string",
    "option_description": "string",
    "discount_text": "string"
  },
  "partial": {
    "selling_plan_id": "string",
    "checkout_charge": {
      "charge_type": "percentage",
      "charge_amount": 1
    },
    "remaining_balance": {
      "charge_trigger": "exact_time",
      "charge_exact_time": null,
      "days_after_checkout": 1
    },
    "price_adjustment": {
      "adjustment_type": "percentage",
      "adjustment_amount": null
    },
    "option_title": "string",
    "option_description": "string",
    "discount_text": "string"
  },
  "collection_schedule": "manual",
  "show_payment_widget": true,
  "show_discounted_price": null,
  "currency_code": null
}
```

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 404

The resource does not exist for this shop, or the action path is not registered.

```json
{
  "errors": [
    "Offer not found"
  ],
  "code": "not_found",
  "details": [
    {
      "code": "not_found",
      "message": "Offer not found",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

