> ## 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.

# Create a recurring expense

> Adds an expense that comes round. When it falls due it waits to be answered: paid, or skipped this once. Refused with `business_details_required` until the store has its business details.

Needs the `expenses.write` permission (Change Expenses).



## OpenAPI

````yaml /api-reference/openapi.json post /stores/{storeId}/recurring-expenses
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}/recurring-expenses:
    post:
      tags:
        - Expense setup
      summary: Create a recurring expense
      description: >-
        Adds an expense that comes round. When it falls due it waits to be
        answered: paid, or skipped this once. Refused with
        `business_details_required` until the store has its business details.


        Needs the `expenses.write` permission (Change Expenses).
      operationId: recurringExpenses.create
      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:
                payee:
                  type: string
                  description: Who is paid, up to 120 characters.
                amount:
                  type: number
                  description: How much each time, in the store's currency.
                cadence:
                  type: string
                  description: How often it comes round.
                  enum:
                    - month
                    - year
                nextOn:
                  type: string
                  description: The day it is next due, as `YYYY-MM-DD`.
                method:
                  type: string
                  description: How it is paid.
                  enum:
                    - card
                    - bank
                    - crypto
                    - paypal
                    - cash
                    - other
                categoryId:
                  type: string
                  description: The expense category it is filed in.
                note:
                  type: string
                  description: A note, up to 255 characters.
                reference:
                  type: string
                  description: A reference, up to 160 characters.
              required:
                - payee
                - amount
                - cadence
                - nextOn
      responses:
        '201':
          description: It worked.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  message:
                    nullable: true
                  code:
                    nullable: true
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      payee:
                        type: string
                      note:
                        type: string
                      category:
                        nullable: true
                      method:
                        type: string
                      reference:
                        type: string
                      amount:
                        type: integer
                      cadence:
                        type: string
                      onDay:
                        type: integer
                      nextOn:
                        type: string
                      asks:
                        type: boolean
                      paused:
                        type: boolean
                      waiting:
                        type: boolean
                      updatedAt:
                        type: string
              example:
                success: true
                message: null
                code: null
                data:
                  id: 6b15ac7a-d376-43b3-a9a0-acc1c1ace8cb
                  payee: Cloudflare
                  note: ''
                  category: null
                  method: card
                  reference: ''
                  amount: 25
                  cadence: month
                  onDay: 27
                  nextOn: '2026-10-27'
                  asks: false
                  paused: false
                  waiting: false
                  updatedAt: '2026-10-22T16:20:20.057Z'
        '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.recurringExpenses.create({
              payee: "...",
              amount: 1,
              cadence: "month",
              nextOn: "...",
            });
        - lang: php
          label: PHP
          source: |
            <?php

            require 'vendor/autoload.php';

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

            $result = $shoply->recurringExpenses->create([
                'payee' => '...',
                'amount' => 1,
                'cadence' => 'month',
                'nextOn' => '...',
            ]);
        - lang: python
          label: Python
          source: >
            import shoply


            client = shoply.Client()  # reads SHOPLY_API_KEY


            result = client.recurringExpenses.create(payee="...", amount=1,
            cadence="month", nextOn="...")
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.