FCORE_PAY) and Subscriptions (FCORE_MEM) service-layer events in a stable HTTP contract so that external systems can drive order creation, line-item maintenance, renewal generation, and subscription cancellation without writing Apex.
Welcome
This API exposes five operations across four resource families:- Order — create a new Order (
POST /v1/order). - Order Item — add (
POST /v1/order-item) or remove (DELETE /v1/order-item/{id}) line items on an existing Order. - Order Renewal — generate renewal orders from sets of Purchase Activities (
POST /v1/orderRenewal). - Subscription Cancellation — cancel one or more subscription renewals (
POST /v1/subscription/cancel).
Base URL
Salesforce Apex REST endpoints live under your org’s My Domain:{instance} with your org’s My Domain prefix (for example, acme-dev for https://acme-dev.my.salesforce.com). Sandboxes use the standard <domain>.sandbox.my.salesforce.com form. The {path} portion is the operation path documented for each endpoint (for example, /v1/order).
Authentication
Every endpoint requires a Salesforce session-scoped bearer token in theAuthorization header:
- OAuth 2.0 — recommended for server-to-server and user-delegated integrations. See Salesforce’s OAuth 2.0 authorization flows.
- SOAP login API — returns a session id directly. See Salesforce’s SOAP
login()reference.
Versioning
The path prefix/v1/ is the API major version. Backwards-compatible additions are made within /v1/; any breaking change introduces a new major version (/v2/) and the previous version is supported in parallel for a deprecation window.
Error handling
All endpoints return JSON responses. Standard HTTP status codes are used:
Error responses share a common envelope:
"success": true and may include operation-specific fields (for example, id and uuid on POST /v1/order).