---
title: "Creates a RecurringCharge resource."
method: POST
path: "/recurring_charges"
tags: ["RecurringCharge"]
---

# Creates a RecurringCharge resource.

`POST /recurring_charges`

Creates a RecurringCharge resource.

## Request body

- RecurringCharge
  - `id` string
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `name` string, nullable — Name of the recurring charge
  - `srcId` string, nullable — Unique identifier for each recurring charge
  - `apiClientId` string, nullable — API key for the app the charge is associated with
  - `price` integer, nullable — The price of the recurring application charge
  - `status` string, nullable — The status of the recurring charge e.g. "Pending" e.g. "Accepted"
  - `returnUrl` string, nullable — The URL where the merchant is redirected afteraccepting the charge
  - `billingDate` string, date-time, nullable — The date and time when the customer is billed
  - `created` string, date-time, nullable — The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z"
  - `modified` string, date-time, nullable — The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z"
  - `activationDate` string, date-time, nullable — The date and time when the customer activated the recurring charge
  - `cancellationDate` string, date-time, nullable — The date and time when the merchant cancelled their recurring charge
  - `trialDays` integer, nullable — The number of days that the customer is eligible for a free trial
  - `trialEndsOn` string, date-time, nullable — The date and time when the free trial ends
  - `decoratedReturnUrl` string, nullable — The display URL where the merchant is redirected after accepting a charge

## Response `201`

RecurringCharge resource created

- RecurringCharge
  - `id` string
  - `integration` string — The key of the integration source e.g. "quickbooks", or "xero"
  - `name` string, nullable — Name of the recurring charge
  - `srcId` string, nullable — Unique identifier for each recurring charge
  - `apiClientId` string, nullable — API key for the app the charge is associated with
  - `price` integer, nullable — The price of the recurring application charge
  - `status` string, nullable — The status of the recurring charge e.g. "Pending" e.g. "Accepted"
  - `returnUrl` string, nullable — The URL where the merchant is redirected afteraccepting the charge
  - `billingDate` string, date-time, nullable — The date and time when the customer is billed
  - `created` string, date-time, nullable — The date and time when the recurring charge was created eg. "2021-11-18T02:17:40.080Z"
  - `modified` string, date-time, nullable — The date and time when the recurring charge was last modified eg. "2021-11-18T02:17:40.080Z"
  - `activationDate` string, date-time, nullable — The date and time when the customer activated the recurring charge
  - `cancellationDate` string, date-time, nullable — The date and time when the merchant cancelled their recurring charge
  - `trialDays` integer, nullable — The number of days that the customer is eligible for a free trial
  - `trialEndsOn` string, date-time, nullable — The date and time when the free trial ends
  - `decoratedReturnUrl` string, nullable — The display URL where the merchant is redirected after accepting a charge

## Other responses

- `400` — Invalid input
- `422` — Unprocessable entity

---

[API](https://skmtc.net/bossinsights/apis/boss-insights.md) · [All operations](https://skmtc.net/bossinsights/apis/boss-insights/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/bossinsights/boss-insights/versions/d08a107895ad/schema)