API Reference

Create a rate card

post
https://api.wingspan.app/v3/payments/rate-cards

Create a reusable RateCard defining the pricing tiers and billing rules for a work type or engagement. If externalId is supplied and already exists for the acting Account, the request fails with 409 ResourceConflict; this create is not an upsert.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
string
required
string
string
required
rates
array of objects
required
length ≥ 1
rates*

One rate tier as supplied on RateCard create or update.

string
^(?:[A-Za-z0-9_]{22}|[A-Za-z0-9][A-Za-z0-9_]{0,63})$

Identifier of this rate, such as hourlyRate, unitPrice, or mileage_rate_2025. Rate calculation formulas use it to look up the rate's cost, for example ${rateCard.hourlyRate}. Use 1–64 letters, digits, or underscores, starting with a letter or digit, or exactly 22 letters, digits, or underscores (the format Wingspan generates). These names are reserved and rejected: hasOwnProperty, toJSON, valueOf, constructor, prototype, and isMongooseBuffer. If you leave it out, Wingspan generates one.

string
string
enum

The unit this tier prices. Leave it out for a new tier that prices the WorkDefinition's own unit. For an existing tier, leaving it out keeps its current unit type.

Allowed:
double
required
metadata
object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 4 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json

Updated 4 months ago

Did this page help you?