> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt
> Use this file to discover all available pages before exploring further.

# Set how long an unpaid order is kept

> How long the store keeps an order nobody pays before it is cancelled, from 1 hour to 14 days. A method with a time of its own keeps its own. An order is never cancelled within an hour of a payment being opened on it. Answers the list again, with the store's time in `meta.unpaid`.

Needs the `payments.write` permission (Change Payment Methods).



## OpenAPI

````yaml /api-reference/openapi.json put /stores/{storeId}/payment-methods/unpaid-hours
openapi: 3.1.0
info:
  title: Shoply API
  version: '1'
  description: >-
    Everything a store's own server can do with a secret API key: its catalogue,
    orders, customers, marketing, finance and the rest of what the dashboard
    does. And the Customer API, which a buyer's own device asks with a token of
    theirs.
servers:
  - url: https://api.shoply.gg/v1
security:
  - apiKey: []
tags:
  - name: API key
  - name: Store
  - name: Domain
  - name: Payment methods
  - name: Analytics
  - name: Storefronts
  - name: Storefront code
  - name: Payment Routing
  - name: Custom payment methods
  - name: Products
  - name: Product pictures
  - name: Stock
  - name: Categories
  - name: Upsells
  - name: Subscriptions
  - name: Orders
  - name: Invoices
  - name: Reviews
  - name: Coupons
  - name: Coupon categories
  - name: Coupon pop-up
  - name: Sales
  - name: Blog
  - name: Search settings
  - name: Redirects
  - name: Sitemap
  - name: Cart Recovery
  - name: Email Marketing
  - name: Email Templates
  - name: Customers
  - name: Affiliates
  - name: Support Tickets
  - name: Blacklist
  - name: Fraud protection
  - name: Disputes
  - name: Finance
  - name: Tax
  - name: Expenses
  - name: Expense setup
  - name: API requests
  - name: Webhook endpoints
  - name: Webhook deliveries
  - name: Customer API
paths:
  /stores/{storeId}/payment-methods/unpaid-hours:
    put:
      tags:
        - Payment methods
      summary: Set how long an unpaid order is kept
      description: >-
        How long the store keeps an order nobody pays before it is cancelled,
        from 1 hour to 14 days. A method with a time of its own keeps its own.
        An order is never cancelled within an hour of a payment being opened on
        it. Answers the list again, with the store's time in `meta.unpaid`.


        Needs the `payments.write` permission (Change Payment Methods).
      operationId: paymentMethods.setUnpaidHours
      parameters:
        - name: storeId
          in: path
          required: true
          description: >-
            The store's ID. A key reaches the store it was made in: `GET /key`
            answers which.
          schema:
            type: string
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                hours:
                  type: integer
                  description: Hours, from 1 to 336.
                  example: 24
              required:
                - hours
      responses:
        '200':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        provider:
                          type: string
                        name:
                          type: string
                        kind:
                          type: string
                        blurb:
                          type: string
                        tagline:
                          type: string
                        accent:
                          type: string
                        site:
                          type: string
                        callbackUrl:
                          type: string
                        returnOrigin:
                          type: string
                        originHint:
                          type: string
                        callbackHint:
                          type: string
                        copies:
                          type:
                            - array
                            - object
                        authorizeUrl:
                          type: string
                        connected:
                          type: boolean
                        enabled:
                          type: boolean
                        usable:
                          type: boolean
                        ready:
                          type: boolean
                        testMode:
                          type: boolean
                        modes:
                          type:
                            - array
                            - object
                        mode:
                          type: string
                        label:
                          type: string
                        buyerLabel:
                          type: string
                        defaultLabel:
                          type: string
                        fields:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              label:
                                type: string
                              placeholder:
                                type: string
                              required:
                                type: boolean
                              max:
                                type: integer
                              secret:
                                type: boolean
                              showCallback:
                                type: boolean
                              mode:
                                type: string
                              isSet:
                                type: boolean
                              value:
                                type: string
                        toggles:
                          type: array
                          items:
                            type: object
                            properties:
                              name:
                                type: string
                              label:
                                type: string
                              hint:
                                type: string
                              group:
                                type: string
                              needs:
                                type: string
                              'on':
                                type: boolean
                        unpaidHours:
                          nullable: true
                        updatedAt:
                          type: string
                  meta:
                    type: object
                    properties:
                      order:
                        type: array
                        items:
                          type: string
                      balance:
                        type: object
                        properties:
                          enabled:
                            type: boolean
                          holders:
                            type: integer
                      unpaid:
                        type: object
                        properties:
                          hours:
                            type: integer
                          presets:
                            type: array
                            items:
                              type: integer
                          least:
                            type: integer
                          most:
                            type: integer
                      routing:
                        type: object
                        properties:
                          providers:
                            type: array
                            items:
                              type: string
              example:
                success: true
                message: null
                code: null
                data:
                  - provider: nmi
                    name: NMI
                    kind: fiat
                    blurb: >-
                      Accept cards through NMI, or a provider that resells it
                      under its own name. Buyers enter their card in the
                      gateway's own secure window.
                    tagline: >-
                      Accept cards on your checkout through your NMI gateway
                      account.
                    accent: '#32165d'
                    site: https://docs.nmi.com/docs/getting-your-api-keys
                    callbackUrl: >-
                      http://localhost:8000/api/payments/nmi/callback/743d82fb-6aad-44bb-ab00-d54c4b0eecb7
                    returnOrigin: ''
                    originHint: ''
                    callbackHint: ''
                    copies: []
                    authorizeUrl: ''
                    connected: true
                    enabled: true
                    usable: true
                    ready: true
                    testMode: false
                    modes: []
                    mode: ''
                    label: ''
                    buyerLabel: Credit/Debit Card (NMI)
                    defaultLabel: Credit/Debit Card (NMI)
                    fields:
                      - name: public_key
                        label: Public Security Key
                        placeholder: With Tokenization and Checkout permissions
                        required: true
                        max: 255
                        secret: false
                        showCallback: false
                        mode: ''
                        isSet: true
                        value: checkout_public_kkkkkkkkkkkkkkkkkkkkkkkkkkkkkkkk
                      - name: security_key
                        label: Private Security Key
                        placeholder: With API and Query permissions
                        required: true
                        max: 255
                        secret: true
                        showCallback: false
                        mode: ''
                        isSet: true
                        value: ''
                    toggles:
                      - name: require_billing
                        label: Require Billing Information
                        hint: >-
                          Ask card buyers for their name and billing address at
                          checkout, and send it with the charge.
                        group: Card Checks
                        needs: ''
                        'on': false
                      - name: three_ds
                        label: Check Cards With 3D Secure
                        hint: >-
                          The buyer's bank confirms the card is theirs before it
                          is charged, most often without asking them anything.
                        group: Card Checks
                        needs: require_billing
                        'on': false
                    unpaidHours: null
                    updatedAt: '2026-10-22T16:20:19.558Z'
                  - provider: tagada
                    name: Tagada
                    kind: fiat
                    blurb: >-
                      Accept cards through your Tagada account. Buyers type
                      their card on the checkout itself, and Tagada charges it
                      through the processors you have connected there.
                    tagline: >-
                      Accept cards through the processors you connect in Tagada,
                      on your own checkout.
                    accent: '#16191d'
                    site: https://app.tagada.io/
                    callbackUrl: >-
                      http://localhost:8000/api/payments/tagada/callback/743d82fb-6aad-44bb-ab00-d54c4b0eecb7
                    returnOrigin: ''
                    originHint: ''
                    callbackHint: ''
                    copies: []
                    authorizeUrl: ''
                    connected: true
                    enabled: true
                    usable: true
                    ready: true
                    testMode: false
                    modes: []
                    mode: ''
                    label: ''
                    buyerLabel: Credit/Debit Card (Tagada)
                    defaultLabel: Credit/Debit Card (Tagada)
                    fields:
                      - name: store_id
                        label: Store ID
                        placeholder: store_...
                        required: true
                        max: 255
                        secret: false
                        showCallback: false
                        mode: ''
                        isSet: true
                        value: store_northwind01
                      - name: api_key
                        label: API Key
                        placeholder: sk_crm_...
                        required: true
                        max: 255
                        secret: true
                        showCallback: false
                        mode: ''
                        isSet: true
                        value: ''
                    toggles: []
                    unpaidHours: null
                    updatedAt: '2026-10-22T16:20:19.559Z'
                meta:
                  order:
                    - nmi
                    - tagada
                  balance:
                    enabled: true
                    holders: 1
                  unpaid:
                    hours: 24
                    presets:
                      - 1
                      - 2
                    least: 1
                    most: 336
                  routing:
                    providers:
                      - nmi
                      - tagada
        '401':
          $ref: '#/components/responses/NoKey'
        '403':
          $ref: '#/components/responses/NotAllowed'
        '404':
          $ref: '#/components/responses/NotFound'
        '422':
          $ref: '#/components/responses/Refused'
        '429':
          $ref: '#/components/responses/TooMany'
      x-codeSamples:
        - lang: javascript
          label: Node.js
          source: |
            import Shoply from "@shoplygg/node";

            const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY });

            const result = await shoply.paymentMethods.setUnpaidHours({
              hours: 24,
            });
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

            $shoply = new Shoply\Client(['apiKey' => getenv('SHOPLY_API_KEY')]);

            $result = $shoply->paymentMethods->setUnpaidHours([
                'hours' => 24,
            ]);
        - lang: python
          label: Python
          source: |
            import shoply

            client = shoply.Client()  # reads SHOPLY_API_KEY

            result = client.paymentMethods.setUnpaidHours(hours=24)
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        A word of your own for this one change, up to 180 letters, digits, dots,
        dashes, underscores and colons. Sent again with the same key, the
        request is not carried out twice: the first answer comes back, with
        `Idempotent-Replay: true`.
      schema:
        type: string
  responses:
    NoKey:
      description: >-
        No API key was sent, or the one sent is not a live key:
        `api_key_required`, `invalid_api_key`.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotAllowed:
      description: >-
        The key is real and may not do this: `missing_scope` (with
        `requiredScope`), `ip_not_allowed`, `account_unavailable`, or
        `dashboard_only` for something only a person in the dashboard may do.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    NotFound:
      description: >-
        There is no such thing in this store: `not_found`. A store that is not
        the key's own is answered the same way.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    Refused:
      description: >-
        The request was understood and not carried out. `validation_failed` says
        what is wrong with each field under `errors`; other codes are the
        route's own.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
    TooMany:
      description: >-
        The key has used up its budget for now: `rate_limited`. `Retry-After`
        says how many seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Refusal'
  schemas:
    Refusal:
      type: object
      properties:
        success:
          type: boolean
          example: false
        message:
          type: string
          description: What is wrong, in words for a person.
        code:
          type: string
          description: What is wrong, as a word that does not change.
        data:
          nullable: true
        errors:
          type: object
          description: >-
            For `validation_failed`: what is wrong with each field, by the
            field's name.
          additionalProperties:
            type: string
      required:
        - success
        - message
        - code
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        A secret API key, made under Developers in the dashboard:
        `Authorization: Bearer shoply_sk_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.