Stripe

Create a charge treatment rule

Creates a charge treatment rule at the end of the account's list; responds 201.

  • A rule matches by condition and either invoices the charge or excludes it with non_invoice_reason.
  • Fails with charge_rule_invalid or charge_rule_limit_reached.
post/companies/{company}/connected-accounts/{account}/charge-rules

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/connected-accounts/{account}/charge-rules
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

accountstring uuid required

Public identifier (UUID v7) of the connected payment account.

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

outcome'invoice' | 'do_not_invoice' required
conceptstring nullable
vat_ratenumber nullable
non_invoice_reason'indemnity_not_subject' | 'multipurpose_voucher' | 'invoiced_elsewhere' | 'null' nullable

Response

The newly created rule, placed at the end of the list.

Example response

{
  "data": {
    "id": "0192e7d0-5e6f-7a4c-b123-4d5e6f708192",
    "object": "charge_rule",
    "position": 1,
    "condition": {
      "type": "metadata_equals",
      "key": "tipo",
      "value": "penalizacion"
    },
    "outcome": "do_not_invoice",
    "non_invoice_reason": "indemnity_not_subject",
    "created_at": "2026-09-20T09:15:00+00:00",
    "updated_at": "2026-09-20T09:15:00+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.