Update Cashback Rule
Updates a cashback rule funded by the authenticated platform account. Requires payout:transfer_funds. Only merchant_name, merchant_category_code, description, and expires_at can change; starts_at, rate_bps, funding_account_id, and scoped_account_id are immutable. Omitted fields stay unchanged. Scheduled, active, and expired rules can be updated; discarded rules cannot. Updating a rule does not transfer funds.
Authorizations
An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.
Headers
Pins the request to a dated API version.
"2026-09-11"
Path Parameters
ID of the cashback rule, prefixed cicbr_.
Body
Description of the rule. Set null to clear it.
255"Cloud cashback"
Exclusive end as an ISO 8601 timestamp, strictly later than the original starts_at. May be in the past to end an active rule. Set null to remove the expiration.
"2026-01-01T12:00:00.000Z"
Four-digit MCC, including leading zeros. Must match together with merchant_name.
4^[0-9]{4}$"7372"
Raw merchant name reported by the card provider. Must contain a non-whitespace character. Matched with the MCC; not a substring or wildcard.
1 - 128"ACME CLOUD"
Response
cashback rule updated
When the rule was created, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
Optional description of the cashback rule.
"Cloud cashback"
When the rule was discarded, as an ISO 8601 timestamp. Null means it has not been discarded.
Exclusive end of the eligibility window, as an ISO 8601 timestamp. Null means no expiration.
"2026-01-01T12:00:00.000Z"
Platform account designated to fund cashback, prefixed biz_. Derived from the authenticated credential.
"biz_xxxxxxxxxxxxxx"
Cashback rule ID, prefixed cicbr_.
"cicbr_xxxxxxxxxxxxxx"
Four-digit merchant category code. Both merchant filters must match.
"7372"
Raw merchant name reported by the card provider. Matched together with the merchant category code; not a substring or enriched display-name match.
"ACME CLOUD"
Cashback rate in basis points. 100 means 1%, and 10000 means 100%.
500
Connected account ID, prefixed biz_. Null designates all direct connected accounts of the funding platform.
"biz_xxxxxxxxxxxxxx"
Inclusive start of the rule's eligibility window, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
When the rule was last updated, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"

