74:I[919841,["/_next/static/chunks/0_ng8v-a8w9fg.js","/_next/static/chunks/3wfeifyqqf5-f.js","/_next/static/chunks/1y60nrw7elmvj.js","/_next/static/chunks/387q3378a15wt.js","/_next/static/chunks/02buk-rmw_od_.js","/_next/static/chunks/3tvkmf4syee7q.js","/_next/static/chunks/3o-8md2j3ccxx.js","/_next/static/chunks/3fihzdt7on6v4.js","/_next/static/chunks/1cg8jsrn_p4qf.js","/_next/static/chunks/25o59k67f0mvw.js","/_next/static/chunks/1p_2l-xt9r80n.js"],"DocsPage"] 75:I[919841,["/_next/static/chunks/0_ng8v-a8w9fg.js","/_next/static/chunks/3wfeifyqqf5-f.js","/_next/static/chunks/1y60nrw7elmvj.js","/_next/static/chunks/387q3378a15wt.js","/_next/static/chunks/02buk-rmw_od_.js","/_next/static/chunks/3tvkmf4syee7q.js","/_next/static/chunks/3o-8md2j3ccxx.js","/_next/static/chunks/3fihzdt7on6v4.js","/_next/static/chunks/1cg8jsrn_p4qf.js","/_next/static/chunks/25o59k67f0mvw.js","/_next/static/chunks/1p_2l-xt9r80n.js"],"DocsTitle"] 76:I[919841,["/_next/static/chunks/0_ng8v-a8w9fg.js","/_next/static/chunks/3wfeifyqqf5-f.js","/_next/static/chunks/1y60nrw7elmvj.js","/_next/static/chunks/387q3378a15wt.js","/_next/static/chunks/02buk-rmw_od_.js","/_next/static/chunks/3tvkmf4syee7q.js","/_next/static/chunks/3o-8md2j3ccxx.js","/_next/static/chunks/3fihzdt7on6v4.js","/_next/static/chunks/1cg8jsrn_p4qf.js","/_next/static/chunks/25o59k67f0mvw.js","/_next/static/chunks/1p_2l-xt9r80n.js"],"DocsBody"] 77:I[783303,["/_next/static/chunks/0_ng8v-a8w9fg.js","/_next/static/chunks/3wfeifyqqf5-f.js","/_next/static/chunks/1y60nrw7elmvj.js","/_next/static/chunks/387q3378a15wt.js","/_next/static/chunks/02buk-rmw_od_.js","/_next/static/chunks/3tvkmf4syee7q.js","/_next/static/chunks/3o-8md2j3ccxx.js","/_next/static/chunks/3fihzdt7on6v4.js","/_next/static/chunks/1cg8jsrn_p4qf.js","/_next/static/chunks/25o59k67f0mvw.js","/_next/static/chunks/1p_2l-xt9r80n.js"],"OpenAPIPage"] 78:T57a,Canonical Project participants, capture, accepted facts and reward accounting. Trusted backends authenticate with a Workspace API key. A trusted call names each participant by the tenant's kind and external ID, and resolves it or creates it; paid history only resolves it. A rekey renames a participant, and its old ID keeps naming it. The landing script exchanges the handoff of a referral click for the handle of the browser (POST /v1/capture); the handoff is its only credential. Widget initialization resolves or creates the participant of its token and records nothing else. The Widget payout details read and record only the payout details of the participant of its token. Schemas describe structural input validation; canonical key, arithmetic, history, and ownership refinements are also enforced by the shared contracts documented in apps/api/README.md. Every error body, including 401, 403, an unknown route (404), and 500, is ErrorResponse. Only the 503 check report of a health route and a 503 while the service closes are different. Each operation lists the error statuses that its route returns. Any operation can also return 500 or a Fastify or Node.js 4xx error, for example 400 for malformed JSON or a malformed URL component, 413 for a body that is too large, 414 for a path parameter that is too long, 415 for an unsupported media type, or 431 for a header section that is too large.79:T833,Says to whom the handle of a browser belongs. The body has one of three forms. `{ handle, participant }`: this browser belongs to the participant. Send it once, at the identity moment (the creation of the account or the group), when the fact that counts comes later, for example a signup at email verification. A signup sent at account creation can send the handle in `identify` instead. Do not identify at sign-in, verification, or account linking. The call creates the participant when the Project does not have it. `{ handle, reference }`: this browser belongs to the person of a flow that starts before the account exists and can end on another device or in a hosted login, such as a magic link or a one-time code. `reference.key` is your key of the flow, unique in the Project and bound to its challenge (for example a digest of the magic-link token); a key is never used again. The call that names an unknown key creates its reference, which expires at `reference.expiresAt`: after the receipt and at most 90 days after it; the default is 24 hours after it. An expired reference gets 409. `{ reference, participant }`: the account of the flow exists. The reference resolves once to the participant, and the handles identified to it then belong to the participant. The same participant again returns the first result; another participant, or a reference that expired before it resolved, gets 409. A key that no handle named yet is created resolved, so the two calls can come in either order. A handle is identified once: the same target again returns the first identification, and another target gets 409. An unknown handle, or a handle of another Project, gets 404. `observedAt` is the time of the identity moment; the default is the receipt. A caller clock can run ahead: an `observedAt` up to 5 minutes after the receipt records the receipt, and a later one gets 400. The click window of a handle ends at its identification, also when its reference resolves later. A fact uses only the identifications and resolves that RefRef received at or before the fact; a fact never waits for one. 7a:T80a,Accepts one canonical Event of any type. A purchase sends `type: "purchase"` and its economic facts in `purchase`; the server derives its key and time. A tenant-defined type, which starts with `custom_`, sends its `type`, `sourceEventId`, and `occurredAt`. Names without the prefix are reserved. A participant has one signup, so a `signup` can leave out `sourceEventId` and `occurredAt`: its key is then derived from the participant, and its time is the receipt. A second signup with another key gets 409. Every Event gets an attribution decision. The first Event of a qualifying type of the Project (by default `signup` and `purchase`) with an eligible touch creates the referral; a later Event of any type uses the referral, and the `referrer` and `referee` rules of its type then evaluate it. The `subject` rules of the Programs in which the participant is enrolled evaluate every Event. A type that is not built in, not a qualifying type of the Project, and not named by a benefit rule of the Project is refused with 422. An Event carries no browser data. Only a signup can carry `identify: { handle }`, which identifies the handle of the browser where the account was created to the participant of the signup, as POST /v1/identify does, in the same transaction. The handle comes from a browser cookie, so any string of at most 4096 characters is accepted. A failed identification never fails the Event: the response then has `identified: false`. A retry of a stored signup identifies no handle. Every Event can carry `refCode`: the one referral code that the referee entered. It is part of the facts. The code counts when its owner was enrolled in the code's Program when the Event occurred (or when RefRef received it, for an Event dated after its receipt), the Program is active, and the owner is not the participant of the Event; otherwise RefRef ignores it. When the Event creates the referral, a code that counts wins over every click. A purchase under a policy that requires a new customer counts a code only on a first order, as it does a click. 6a:["$","$L74",null,{"full":true,"children":[["$","$L75",null,{"children":"Get Health"}],["$","$L76",null,{"children":["$","$L77",null,{"payload":{"bundled":{"openapi":"3.2.0","info":{"title":"RefRef API","version":"0.1.0","description":"$78"},"servers":[{"url":"https://refref-api.localhost","description":"Checked-in local example; use the existing Portless proxy scheme and port."}],"paths":{"/openapi":{"get":{"operationId":"getOpenApiDocument","tags":["Documentation"],"security":[],"responses":{"200":{"description":"This static OpenAPI document","content":{"text/yaml":{"schema":{"type":"string"}}}}}}},"/":{"get":{"operationId":"getRootHealth","tags":["Health"],"responses":{"200":{"description":"Healthy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}},"503":{"description":"Database unavailable"}}}},"/health":{"get":{"operationId":"getHealth","tags":["Health"],"responses":{"200":{"description":"Healthy","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}},"503":{"description":"Database unavailable"}}}},"/v1/sources":{"post":{"operationId":"registerSourceNamespace","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sourceNamespaceRegistrationSchema"}}}},"responses":{"200":{"description":"Accepted canonical operation; success is true and service result fields are returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/identify":{"post":{"operationId":"identifyHandle","description":"$79","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/identifySchema"}}}},"responses":{"200":{"description":"The identification of the handle to the participant or to the reference, or the resolved reference","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdentifyResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/track/events":{"post":{"operationId":"intakeEvent","description":"$7a","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/eventIntakeSchema"}}}},"responses":{"200":{"description":"Accepted Event; returns the Event and participant IDs and the processing state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TrackResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"},"422":{"$ref":"#/components/responses/UnknownEventType"}}}},"/v1/subscriptions/facts":{"post":{"operationId":"intakeSubscriptionFact","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/subscriptionFactIntakeSchema"}}}},"responses":{"200":{"description":"Accepted canonical operation; success is true and service result fields are returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/evidence/paid-history":{"post":{"operationId":"submitPaidHistory","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/paidHistoryEvidenceIntakeSchema"}}}},"responses":{"200":{"description":"Accepted canonical operation; success is true and service result fields are returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/benefit-rules":{"post":{"operationId":"createBenefitRule","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createBenefitRuleSchema"}}}},"responses":{"200":{"description":"Accepted canonical operation; success is true and service result fields are returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/benefit-rules/{ruleId}/terms":{"post":{"operationId":"publishRewardTerms","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publishRewardTermsInput"}}}},"responses":{"200":{"description":"Accepted canonical operation; success is true and service result fields are returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"}}},"get":{"operationId":"listRewardTerms","tags":["Management"],"description":"List the reward terms versions of a benefit rule, newest first. Needs the programs:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"ruleId":{"type":"string"},"programId":{"type":"string"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"version":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"effectiveAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"enabled":{"type":"boolean"},"calculation":{"type":"string","enum":["fixed","percentage","percentage_discount","fixed_quantity"]},"fixedAmountMinor":{"anyOf":[{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},{"type":"null"}]},"currency":{"type":["string","null"]},"currencyExponent":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"rateBps":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"durationMode":{"type":"string","enum":["once","fixed","lifetime"]},"durationMonths":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"customUnitId":{"type":["string","null"]},"unit":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"namePlural":{"type":"string"}},"required":["key","name","namePlural"]},{"type":"null"}]},"quantity":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"validityDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"maxRewardsPerBeneficiary":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"roundingPolicy":{"type":"string","enum":["half_up"]},"refundPolicy":{"type":"string","enum":["proportional"]},"author":{"type":"string"},"changeNote":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","ruleId","programId","beneficiaryRole","benefitKind","version","publishedAt","effectiveAt","enabled","calculation","fixedAmountMinor","currency","currencyExponent","rateBps","durationMode","durationMonths","customUnitId","unit","quantity","validityDays","maxRewardsPerBeneficiary","roundingPolicy","refundPolicy","author","changeNote"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/purchase-adjustments":{"post":{"operationId":"intakePurchaseAdjustment","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/purchaseAdjustmentInputSchema"}}}},"responses":{"200":{"description":"Accepted canonical operation; success is true and service result fields are returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/widget/init":{"post":{"operationId":"initializeWidget","security":[{"WidgetJWT":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/widgetInitRequestSchema"}}}},"responses":{"200":{"description":"The participant ID, its enrollment status, and its links. Init resolves the participant of the token or creates it; it records no enrollment, code, or fact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WidgetResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/widget/payout-details":{"get":{"operationId":"getWidgetPayoutDetails","description":"The cash payouts of the participant that the Widget token names, in the Project of the token (decision 0048). The token needs the widget:read scope. Only USD cash Rewards that RefRef pays out count: a participant without one is not eligible, and so is a participant that the Project does not have yet; the route creates no participant. canSave tells whether the token can save the details (widget:payout).","security":[{"WidgetJWT":[]}],"parameters":[{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"responses":{"200":{"description":"The payout details of the participant; the Widget shows them only when eligible is true","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WidgetPayoutDetailsResponse"}}}},"400":{"$ref":"#/components/responses/InvalidQuery"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"}}},"put":{"operationId":"saveWidgetPayoutDetails","description":"Records the country and the PayPal address of the participant that the Widget token names, with its acceptance of the current payout terms (acceptTerms). The token needs the widget:payout scope. Without paypalEmail the save keeps the current PayPal address, for example to accept new terms; the first save without it gets 400 VALIDATION_ERROR. Only an eligible participant gives payout details, and only when a Program of its cash Rewards offers PayPal; another participant gets 400 INVALID_REQUEST, and so does a participant whose payout details are blocked. In a Live Project, an address in a reserved test domain (.test, .example, .invalid, .localhost, example.com, example.net, or example.org) gets 400 INVALID_REQUEST. The same details again change nothing; a new address replaces the default method.","security":[{"WidgetJWT":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/widgetPayoutDetailsRequestSchema"}}}},"responses":{"200":{"description":"The payout details of the participant after the change","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WidgetPayoutDetailsResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/Forbidden"}}}},"/v1/capture":{"post":{"operationId":"captureHandle","description":"The landing script calls this route from the browser. It exchanges the `refref_handoff` of a\nreferral click for the handle of the browser, and keeps the handle in a first-party cookie. There\nis no API key: the handoff is the credential, and it is valid for 15 minutes. `handle` is the\nhandle that the browser holds, if any; an unknown handle, or a handle of another Project, counts as\nabsent. A click goes to one handle, once. An open handle that the browser holds takes the click; a\nhandle that is already identified is replaced by a new handle. A retry of the same handoff without\na handle returns the handle that took the click. The response is not cached (`Cache-Control:\nno-store`). A handoff that is not valid, or has expired, gets 400.\n","security":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/captureSchema"}}}},"responses":{"200":{"description":"The handle of the browser","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CaptureResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"}}}},"/v1/enrollments":{"post":{"operationId":"enrollParticipant","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/enrollParticipantInput"}}}},"responses":{"200":{"description":"The enrollment of the participant that the body names by kind and external ID, with its participantId. The call resolves the participant or creates it; a retry returns the open enrollment of the same Program","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/enrollments/{enrollmentId}/end":{"post":{"operationId":"endEnrollment","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"enrollmentId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/endEnrollmentInput"}}}},"responses":{"200":{"description":"Accepted canonical operation; success is true and service result fields are returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/participants":{"put":{"operationId":"upsertParticipant","description":"Registers the participant that the body names by kind and external ID: the call resolves it or creates it, and writes the name, email, and billing ID that the body gives. An ID that POST /v1/participants/rekey retired names the renamed participant, and the response gives its current external ID. A field that the body leaves out stays as it is; null clears a name or an email. The billing ID is the participant's customer ID in the Project's billing provider, which delivers account credit and discount Rewards; it is set once. A billing ID that differs from the participant's, or that another participant of the Project has, returns 409. A new billing ID makes the Rewards that wait for it due at once.","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/upsertParticipantInput"}}}},"responses":{"200":{"description":"The participant with its name, email, and billing ID after the call. A retry with the same body returns the same participant and changes nothing","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}},"get":{"operationId":"listParticipants","tags":["Management"],"description":"List the participants of a Project, newest first, 50 per page (offset as a decimal string). kind filters individual or group. Needs the participants:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"offset","in":"query","schema":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"}},{"name":"kind","in":"query","schema":{"type":"string","enum":["individual","group"]}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]},"billingId":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"]},"partnerId":{"type":["string","null"]},"deletedAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]},"isReferrer":{"type":"boolean"},"isReferee":{"type":"boolean"}},"required":["id","createdAt","updatedAt","projectId","kind","externalId","billingId","name","email","partnerId","deletedAt","isReferrer","isReferee"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/participants/rekey":{"post":{"operationId":"rekeyParticipant","description":"Renames the participant that the body names by kind and external ID to newExternalId, for example when your user IDs change. The kind stays. The old ID is retired: it keeps naming the same participant in every call, and it never names another participant of the Project and kind. Name the participant by its current external ID. A retry that names the old ID again returns the participant and changes nothing. An unknown or deleted participant returns 404; the call creates no participant. A new ID that another participant has, or that a rename retired, returns 409, and so does a name that is no longer the current ID. A fact keeps the participant reference that it was sent with: a retry of an earlier fact must name the participant as the first request did.","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/rekeyParticipantInput"}}}},"responses":{"200":{"description":"The participant with its new external ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/referral-codes":{"post":{"operationId":"createReferralCode","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createReferralCodeInput"}}}},"responses":{"200":{"description":"The code of the participant that the body names by kind and external ID in the referral Program programId, with its participantId and programId. The call resolves the participant or creates it, and needs no open enrollment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/v1/referral-links":{"post":{"operationId":"createReferralLink","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createReferralLinkInput"}}}},"responses":{"200":{"description":"A vanity link for the existing code, in the Program programId, of the participant that the body names by kind and external ID. A participant without a code in that Program gets 404 NOT_FOUND, and the call then writes nothing, also no new participant","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/attribution/policies":{"post":{"operationId":"publishAttributionPolicy","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/publishAttributionPolicyInput"}}}},"responses":{"200":{"description":"Accepted canonical operation; success is true and service result fields are returned","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OperationResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/reward-rules":{"get":{"operationId":"listBenefitRules","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1}},{"name":"programId","in":"query","required":true,"schema":{"type":"string","minLength":1}}],"responses":{"200":{"description":"Authenticated Project-scoped result","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BenefitRulesResponse"}}}},"400":{"$ref":"#/components/responses/InvalidQuery"},"401":{"$ref":"#/components/responses/ApiKeyRequired"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFoundInScope"}}}},"/v1/custom-units":{"get":{"operationId":"listCustomUnits","description":"The custom units of the Project, oldest first (decision 0043). A rule's custom reward gives a quantity of one of them.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"responses":{"200":{"description":"The Project's custom units","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomUnitsResponse"}}}},"400":{"$ref":"#/components/responses/InvalidQuery"},"401":{"$ref":"#/components/responses/ApiKeyRequired"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFoundInScope"}}},"post":{"operationId":"createCustomUnit","description":"Creates a custom unit. The key is what your product maps; it is fixed once a rule uses the unit.","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createCustomUnitSchema"}}}},"responses":{"200":{"description":"The new custom unit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomUnitResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/custom-units/{key}":{"patch":{"operationId":"updateCustomUnit","description":"Renames or archives a custom unit. A new name shows everywhere at once; an archived unit takes no new rules.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"key","in":"path","required":true,"schema":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/updateCustomUnitInput"}}}},"responses":{"200":{"description":"The changed custom unit","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomUnitResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/v1/rewards":{"get":{"operationId":"listRewards","description":"A page of Rewards, newest first, with their fulfillment status (decision 0043). Your product grants only the Rewards of the delivery methods operator and manual; RefRef delivers the others. To grant the Rewards that a webhook did not reach, read deliveryMethod=operator (and manual) with fulfillmentStatus=pending.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"programId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"beneficiaryKind","in":"query","required":false,"schema":{"type":"string","enum":["individual","group"]}},{"name":"beneficiaryExternalId","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"benefitKind","in":"query","required":false,"schema":{"type":"string","enum":["cash","credit","discount","custom"]}},{"name":"fulfillmentStatus","in":"query","required":false,"schema":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]}},{"name":"deliveryMethod","in":"query","required":false,"description":"Who delivers the Reward (decision 0048). Your product grants operator and manual.","schema":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]}},{"name":"after","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024}},{"name":"limit","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"A page of Rewards; next is the cursor of the following page, or null","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardsResponse"}}}},"400":{"$ref":"#/components/responses/InvalidQuery"},"401":{"$ref":"#/components/responses/ApiKeyRequired"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFoundInScope"}}}},"/v1/rewards/{rewardId}":{"get":{"operationId":"getReward","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"rewardId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"responses":{"200":{"description":"One Reward","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardResponse"}}}},"400":{"$ref":"#/components/responses/InvalidQuery"},"401":{"$ref":"#/components/responses/ApiKeyRequired"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFoundInScope"}}}},"/v1/rewards/{rewardId}/fulfillment":{"post":{"operationId":"fulfillReward","description":"Records that your product granted the Reward, or that you paid a cash Reward yourself. Only a Reward whose delivery method is `operator` or `manual` takes it; RefRef delivers the other methods, and they return 400. The Reward ID is the idempotency key: a repeat with the same facts, or after a webhook delivery recorded the fulfillment, returns the Reward; other facts return 409. A Reward voided before its grant has a cancelled delivery, and a fulfillment of it returns 409.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"rewardId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fulfillRewardInput"}}}},"responses":{"200":{"description":"The fulfilled Reward","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/rewards/{rewardId}/revocation":{"post":{"operationId":"revokeReward","description":"Records that your product took back a voided Reward that it had granted. Only a Reward whose delivery method is `operator` or `manual` and whose status is `revocation_pending` takes it; a cash Reward is never revoked. A repeat with the same facts returns the Reward; other facts return 409.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"rewardId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/fulfillRewardInput"}}}},"responses":{"200":{"description":"The revoked Reward","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"},"409":{"$ref":"#/components/responses/Conflict"}}}},"/v1/webhook-events":{"get":{"operationId":"listWebhookEvents","description":"Webhook events in commit order after the cursor (decisions 0044 and 0052). A late commit never appears behind a cursor, so a product that missed webhooks catches up from its last next. The webhooks section lists each event type and its data.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"after","in":"query","required":false,"schema":{"type":"string","minLength":1,"maxLength":1024}},{"name":"limit","in":"query","required":false,"schema":{"default":100,"type":"integer","minimum":1,"maximum":500}}],"responses":{"200":{"description":"Events after the cursor; next is the cursor to read after them","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEventsResponse"}}}},"400":{"$ref":"#/components/responses/InvalidQuery"},"401":{"$ref":"#/components/responses/ApiKeyRequired"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFoundInScope"}}}},"/v1/webhook-endpoints":{"get":{"operationId":"listWebhookEndpoints","description":"The webhook endpoints of the Project, oldest first, without their secrets (decision 0052).","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"responses":{"200":{"description":"The Project's webhook endpoints","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointsResponse"}}}},"400":{"$ref":"#/components/responses/InvalidQuery"},"401":{"$ref":"#/components/responses/ApiKeyRequired"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFoundInScope"}}},"post":{"operationId":"createWebhookEndpoint","description":"Subscribes a URL to webhook events of the Project (decision 0052). An automation app subscribes with it and unsubscribes with DELETE. The endpoint keeps the current apiVersion. Its fulfillmentMode is on_delivery by default: a 2xx other than 202 to reward.earned records the Reward's fulfillment. Use explicit when the receiver confirms each grant through POST /v1/rewards/{rewardId}/fulfillment. The URL must use https and reach a public address.","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/createWebhookEndpointSchema"}}}},"responses":{"200":{"description":"The new endpoint and its signing secret","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointResponse"}}}},"400":{"$ref":"#/components/responses/InvalidInput"},"401":{"$ref":"#/components/responses/Unauthenticated"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFound"}}}},"/v1/webhook-endpoints/{endpointId}":{"delete":{"operationId":"deleteWebhookEndpoint","description":"Unsubscribes: deletes the endpoint, its deliveries, and their attempt log. The events stay in the feed.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"endpointId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"responses":{"200":{"description":"The ID of the deleted endpoint","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookEndpointDeletedResponse"}}}},"400":{"$ref":"#/components/responses/InvalidQuery"},"401":{"$ref":"#/components/responses/ApiKeyRequired"},"403":{"$ref":"#/components/responses/EnvironmentMismatch"},"404":{"$ref":"#/components/responses/NotFoundInScope"}}}},"/v1/projects":{"get":{"operationId":"listProjects","tags":["Management"],"description":"List the Projects that this credential reaches in the Workspace, with environment (sandbox or live) and qualifying event types. Select a Project explicitly before other operations.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"after","in":"query","schema":{"type":"string","minLength":1,"maxLength":128}},{"name":"limit","in":"query","schema":{"default":50,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true}}}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/qualifying-event-types":{"put":{"operationId":"setQualifyingEventTypes","tags":["Management"],"description":"Set the Event types that create a referral in the Project (default signup and purchase). A write applies at once. Needs the programs:write key permission.","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetQualifyingEventTypesInput"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"workspaceId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"liveProjectId":{"type":["string","null"]},"name":{"type":"string"},"slug":{"type":"string"},"logo":{"type":["string","null"]},"url":{"type":"string"},"metadata":{"type":["string","null"]},"appType":{"type":["string","null"]},"useCase":{"type":["string","null"]},"paymentProvider":{"type":["string","null"]},"onboardingCompleted":{"type":["boolean","null"]},"onboardingStep":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"qualifyingEventTypes":{"type":"array","items":{"type":"string"}}},"required":["id","createdAt","updatedAt","workspaceId","environment","liveProjectId","name","slug","logo","url","metadata","appType","useCase","paymentProvider","onboardingCompleted","onboardingStep","qualifyingEventTypes"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/program-templates":{"get":{"operationId":"listProgramTemplates","tags":["Management"],"description":"List the Program templates (starting points for common business models) with their suggested rules.","security":[{"WorkspaceApiKey":[]}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object"}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/programs":{"get":{"operationId":"listPrograms","tags":["Management"],"description":"List the Programs of a Project, oldest first, with their enrollment and referral counts. Needs the programs:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"kind":{"type":"string","enum":["referral","loyalty"]},"name":{"type":"string"},"status":{"type":"string"},"startDate":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]},"endDate":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]},"config":{"anyOf":[{"type":"object","properties":{"schemaVersion":{"type":"number","const":1},"brandConfig":{"type":"object","properties":{"primaryColor":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}$"},"landingPageUrl":{"type":"string","pattern":"^https?:\\/\\/[^/?#\\s]+"}},"required":["primaryColor","landingPageUrl"]},"widgetConfig":{"type":"object","properties":{"position":{"type":"string","enum":["bottom-right","bottom-left","top-right","top-left"]},"triggerText":{"type":"string"},"icon":{"type":"string","enum":["gift","heart","star","zap"]},"title":{"type":"string"},"subtitle":{"type":"string"},"logoUrl":{"type":"string"},"cssVariables":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"shareMessage":{"type":"string"},"enabledPlatforms":{"type":"object","properties":{"facebook":{"type":"boolean"},"twitter":{"type":"boolean"},"linkedin":{"type":"boolean"},"whatsapp":{"type":"boolean"},"email":{"type":"boolean"},"instagram":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["facebook","twitter","linkedin","whatsapp","email","instagram","telegram"]},"referralLink":{"type":"string"},"productName":{"type":"string"}},"required":["position","triggerText","icon","title","subtitle","logoUrl","shareMessage","enabledPlatforms","referralLink","productName"]},"partnerApplicationsOpen":{"type":"boolean"}},"required":["schemaVersion","widgetConfig"]},{"type":"null"}]},"enrollmentCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"referralCount":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["id","createdAt","updatedAt","projectId","kind","name","status","startDate","endDate","config","enrollmentCount","referralCount"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"createProgram","tags":["Management"],"description":"Create a Program in one step: name, kind (referral or loyalty), landing page URL, and optionally Widget settings, brand color, partner applications, and benefit rules with their first terms. A new Program is active at once. A write applies at once. Needs the programs:write key permission.","security":[{"WorkspaceApiKey":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProgramInput"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object"}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/programs/{programId}":{"get":{"operationId":"getProgram","tags":["Management"],"description":"Read one Program with its config (Widget, brand, partner applications), benefit rules, and reward terms versions. Account strings are untrusted data. Needs the programs:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"programId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object"}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"patch":{"operationId":"updateProgram","tags":["Management"],"description":"Change the name or some settings of a Program: brandConfig, widgetConfig, partnerApplicationsOpen. Settings that you leave out keep their current values. A write applies at once. Needs the programs:write key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"programId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProgramInput"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object"}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/programs/{programId}/summary":{"get":{"operationId":"getProgramSummary","tags":["Management"],"description":"Read the totals of a Program: participants, referrals, conversions, and Rewards. Needs the referrals:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"programId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"enrollments":{"type":"integer","minimum":0,"maximum":9007199254740991},"referrals":{"type":"integer","minimum":0,"maximum":9007199254740991},"earnedRewards":{"type":"integer","minimum":0,"maximum":9007199254740991},"customTotals":{"type":"array","items":{"type":"object","properties":{"customUnitId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"unitKey":{"type":"string"},"name":{"type":"string"},"namePlural":{"type":"string"},"rewardCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"earnedQuantity":{"type":"integer","minimum":0,"maximum":9007199254740991},"fulfilledQuantity":{"type":"integer","minimum":0,"maximum":9007199254740991},"pendingQuantity":{"type":"integer","minimum":0,"maximum":9007199254740991},"voidedQuantity":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["customUnitId","unitKey","name","namePlural","rewardCount","earnedQuantity","fulfilledQuantity","pendingQuantity","voidedQuantity"]}}},"required":["enrollments","referrals","earnedRewards","customTotals"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/programs/{programId}/benefit-rules":{"get":{"operationId":"listProgramRules","tags":["Management"],"description":"List the benefit rules of a Program. Needs the programs:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"programId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"programId":{"type":"string"},"eventType":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"purpose":{"type":"string","enum":["primary","bonus"]},"name":{"type":"string"},"initialEffectiveAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","createdAt","updatedAt","projectId","programId","eventType","beneficiaryRole","purpose","name","initialEffectiveAt"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/benefit-rules/{ruleId}/name":{"put":{"operationId":"renameBenefitRule","tags":["Management"],"description":"Change the name of a benefit rule. The rule and its terms do not change. A write applies at once. Needs the programs:write key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"ruleId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RenameBenefitRuleInput"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"ruleId":{"type":"string"},"name":{"type":"string"}},"required":["ruleId","name"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/programs/{programId}/referee-offer/versions":{"get":{"operationId":"listRefereeOffers","tags":["Management"],"description":"List the referee offer versions of a referral Program, newest first. Needs the programs:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"programId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"calculation":{"type":"string","enum":["percentage","fixed"]},"rateBps":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"amountMinor":{"anyOf":[{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},{"type":"null"}]},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":0,"maximum":6},"minimumSubtotalMinor":{"anyOf":[{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},{"type":"null"}]},"validityDays":{"type":"integer","minimum":1,"maximum":3650},"combinesWithProductDiscounts":{"default":false,"type":"boolean"},"combinesWithOrderDiscounts":{"default":false,"type":"boolean"},"combinesWithShippingDiscounts":{"default":false,"type":"boolean"},"changeNote":{"type":"string","minLength":1,"maxLength":2000},"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"programId":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"publishedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"effectiveAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"author":{"type":"string"}},"required":["calculation","amountMinor","currency","currencyExponent","minimumSubtotalMinor","validityDays","changeNote","id","createdAt","updatedAt","projectId","programId","version","publishedAt","effectiveAt","author"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"post":{"operationId":"publishRefereeOffer","tags":["Management"],"description":"Publish a new referee offer version: what a referred person gets, as shown in the Widget and join page. A write applies at once. Needs the programs:write key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"programId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishRefereeOfferInput"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"offerVersionId":{"type":"string"},"version":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"publishedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"effectiveAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["offerVersionId","version","publishedAt","effectiveAt"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/programs/{programId}/delivery-settings":{"get":{"operationId":"getDeliverySettings","tags":["Management"],"description":"Read how a Program delivers Rewards: hold days and the method of each benefit kind. Needs the programs:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"programId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"programId":{"type":"string"},"holdDays":{"type":"integer","minimum":0,"maximum":365},"cashMethod":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"creditMethod":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"discountMethod":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"customMethod":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"planUpgrades":{"type":"array","items":{"type":"object","properties":{"unitKey":{"type":"string"},"plan":{"type":"string"},"periods":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["unitKey","plan","periods"]}},"options":{"type":"object","properties":{"cash":{"type":"array","items":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]}},"credit":{"type":"array","items":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]}},"discount":{"type":"array","items":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]}},"custom":{"type":"array","items":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]}}},"required":["cash","credit","discount","custom"]},"updatedAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]}},"required":["programId","holdDays","cashMethod","creditMethod","discountMethod","customMethod","planUpgrades","options","updatedAt"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}},"put":{"operationId":"updateDeliverySettings","tags":["Management"],"description":"Change how a Program delivers Rewards: hold days and the method of each benefit kind. Fields that you leave out keep their values. A write applies at once. Needs the programs:write key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"programId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDeliverySettingsInput"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"programId":{"type":"string"},"holdDays":{"type":"integer","minimum":0,"maximum":365},"cashMethod":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"creditMethod":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"discountMethod":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"customMethod":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"planUpgrades":{"type":"array","items":{"type":"object","properties":{"unitKey":{"type":"string"},"plan":{"type":"string"},"periods":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["unitKey","plan","periods"]}},"options":{"type":"object","properties":{"cash":{"type":"array","items":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]}},"credit":{"type":"array","items":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]}},"discount":{"type":"array","items":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]}},"custom":{"type":"array","items":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]}}},"required":["cash","credit","discount","custom"]},"updatedAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]}},"required":["programId","holdDays","cashMethod","creditMethod","discountMethod","customMethod","planUpgrades","options","updatedAt"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/participants/{id}":{"get":{"operationId":"getParticipant","tags":["Management"],"description":"Read one participant with its enrollments, referral codes and links, the referral that names it as referee, its newest referrals as referrer, and its newest Events. Needs the participants:read and referrals:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"participant":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]},"billingId":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"]},"partnerId":{"type":["string","null"]},"deletedAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]}},"required":["id","createdAt","updatedAt","projectId","kind","externalId","billingId","name","email","partnerId","deletedAt"]},"enrollments":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"participantId":{"type":"string"},"programId":{"type":"string"},"startsAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"endsAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]}},"required":["id","createdAt","updatedAt","projectId","participantId","programId","startsAt","endsAt"]}},"refCodes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"code":{"type":"string"},"participantId":{"type":"string"},"programId":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","code","participantId","programId"]}},"links":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"slug":{"type":"string"},"refCodeId":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","slug","refCodeId"]}},"referredBy":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"referrerParticipantId":{"type":"string"},"refereeParticipantId":{"type":"string"},"enrollmentId":{"type":"string"},"programId":{"type":"string"},"touchId":{"type":"string"},"bindingEventId":{"type":["string","null"]},"bindingSubscriptionFactId":{"type":["string","null"]},"bindingOccurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"selectedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"policyVersionId":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","referrerParticipantId","refereeParticipantId","enrollmentId","programId","touchId","bindingEventId","bindingSubscriptionFactId","bindingOccurredAt","selectedAt","policyVersionId"]},{"type":"null"}]},"referrals":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"referrerParticipantId":{"type":"string"},"refereeParticipantId":{"type":"string"},"enrollmentId":{"type":"string"},"programId":{"type":"string"},"touchId":{"type":"string"},"bindingEventId":{"type":["string","null"]},"bindingSubscriptionFactId":{"type":["string","null"]},"bindingOccurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"selectedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"policyVersionId":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","referrerParticipantId","refereeParticipantId","enrollmentId","programId","touchId","bindingEventId","bindingSubscriptionFactId","bindingOccurredAt","selectedAt","policyVersionId"]}},"events":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"participantId":{"type":"string"},"type":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"actorParticipantId":{"type":["string","null"]},"sourceNamespaceId":{"type":"string"},"sourceEventId":{"type":"string"},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"receivedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"normalizedFacts":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"factsHash":{"type":"string"},"processingState":{"type":"string","enum":["pending","complete"]},"processingReason":{"anyOf":[{"type":"string","enum":["awaiting_attribution","fact_in_future","subscription_origin_unresolved","reward_evaluation_pending","historical_attribution_pending","paid_history_incomplete","paid_history_requires_reconciliation","paid_anchor_unresolved","processing_error"]},{"type":"null"}]},"attemptCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextAttemptAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","createdAt","updatedAt","projectId","participantId","type","actorParticipantId","sourceNamespaceId","sourceEventId","occurredAt","receivedAt","normalizedFacts","factsHash","processingState","processingReason","attemptCount","nextAttemptAt"]}}},"required":["participant","enrollments","refCodes","links","referredBy","referrals","events"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/referrers":{"get":{"operationId":"listReferrers","tags":["Management"],"description":"List the participants with an enrollment (open or ended), newest first, 50 per page. Needs the participants:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"offset","in":"query","schema":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]},"billingId":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"]},"partnerId":{"type":["string","null"]},"deletedAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]}},"required":["id","createdAt","updatedAt","projectId","kind","externalId","billingId","name","email","partnerId","deletedAt"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/referrals":{"get":{"operationId":"listReferrals","tags":["Management"],"description":"List the referrals of a Project, newest first, 50 per page. Needs the referrals:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"offset","in":"query","schema":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"referrerParticipantId":{"type":"string"},"refereeParticipantId":{"type":"string"},"enrollmentId":{"type":"string"},"programId":{"type":"string"},"touchId":{"type":"string"},"bindingEventId":{"type":["string","null"]},"bindingSubscriptionFactId":{"type":["string","null"]},"bindingOccurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"selectedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"policyVersionId":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","referrerParticipantId","refereeParticipantId","enrollmentId","programId","touchId","bindingEventId","bindingSubscriptionFactId","bindingOccurredAt","selectedAt","policyVersionId"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/referrals/{id}":{"get":{"operationId":"getReferral","tags":["Management"],"description":"Read one referral: referrer, referee, Program, enrollment, and touch. Needs the referrals:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"referrerParticipantId":{"type":"string"},"refereeParticipantId":{"type":"string"},"enrollmentId":{"type":"string"},"programId":{"type":"string"},"touchId":{"type":"string"},"bindingEventId":{"type":["string","null"]},"bindingSubscriptionFactId":{"type":["string","null"]},"bindingOccurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"selectedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"policyVersionId":{"type":"string"}},"required":["id","createdAt","updatedAt","projectId","referrerParticipantId","refereeParticipantId","enrollmentId","programId","touchId","bindingEventId","bindingSubscriptionFactId","bindingOccurredAt","selectedAt","policyVersionId"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/events":{"get":{"operationId":"listEvents","tags":["Management"],"description":"List the Events of a Project, newest first, 50 per page, with their processing state. Use diagnose_event for one Event. Needs the referrals:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"offset","in":"query","schema":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"participantId":{"type":"string"},"type":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"actorParticipantId":{"type":["string","null"]},"sourceNamespaceId":{"type":"string"},"sourceEventId":{"type":"string"},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"receivedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"normalizedFacts":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"factsHash":{"type":"string"},"processingState":{"type":"string","enum":["pending","complete"]},"processingReason":{"anyOf":[{"type":"string","enum":["awaiting_attribution","fact_in_future","subscription_origin_unresolved","reward_evaluation_pending","historical_attribution_pending","paid_history_incomplete","paid_history_requires_reconciliation","paid_anchor_unresolved","processing_error"]},{"type":"null"}]},"attemptCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextAttemptAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","createdAt","updatedAt","projectId","participantId","type","actorParticipantId","sourceNamespaceId","sourceEventId","occurredAt","receivedAt","normalizedFacts","factsHash","processingState","processingReason","attemptCount","nextAttemptAt"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/events/{id}":{"get":{"operationId":"getEvent","tags":["Management"],"description":"Read one Event with its facts. Needs the referrals:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"participantId":{"type":"string"},"type":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"actorParticipantId":{"type":["string","null"]},"sourceNamespaceId":{"type":"string"},"sourceEventId":{"type":"string"},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"receivedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"normalizedFacts":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"factsHash":{"type":"string"},"processingState":{"type":"string","enum":["pending","complete"]},"processingReason":{"anyOf":[{"type":"string","enum":["awaiting_attribution","fact_in_future","subscription_origin_unresolved","reward_evaluation_pending","historical_attribution_pending","paid_history_incomplete","paid_history_requires_reconciliation","paid_anchor_unresolved","processing_error"]},{"type":"null"}]},"attemptCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextAttemptAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","createdAt","updatedAt","projectId","participantId","type","actorParticipantId","sourceNamespaceId","sourceEventId","occurredAt","receivedAt","normalizedFacts","factsHash","processingState","processingReason","attemptCount","nextAttemptAt"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/events/{eventId}/diagnosis":{"get":{"operationId":"diagnoseEvent","tags":["Management"],"description":"Explain an Event: processing, attribution decision, and reward evaluations. Pending is not unattributed; an earned Reward does not prove payment delivery. Needs the referrals:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"eventId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object"}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/purchases":{"get":{"operationId":"listPurchases","tags":["Management"],"description":"List the 100 newest purchases of a Project. Needs the referrals:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"eventId":{"type":"string"},"eventType":{"type":"string","const":"purchase"},"participantId":{"type":"string"},"sourceNamespaceId":{"type":"string"},"resourceType":{"type":"string","enum":["invoice","order"]},"externalResourceId":{"type":"string"},"subscriptionId":{"type":["string","null"]},"paidAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"currency":{"type":"string"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paidAmountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"taxMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"commissionableAmountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"}},"required":["id","createdAt","updatedAt","projectId","eventId","eventType","participantId","sourceNamespaceId","resourceType","externalResourceId","subscriptionId","paidAt","currency","currencyExponent","paidAmountMinor","taxMinor","commissionableAmountMinor"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/reward-evaluations":{"get":{"operationId":"listRewardEvaluations","tags":["Management"],"description":"List the 100 newest reward evaluations: each rule decision of each Event. Needs the referrals:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"eventId":{"type":"string"},"conversionAttributionId":{"type":["string","null"]},"participantId":{"type":"string"},"programId":{"type":"string"},"ruleId":{"type":"string"},"termsVersionId":{"type":"string"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"allowanceId":{"type":["string","null"]},"outcome":{"type":"string","enum":["earned","no_reward"]},"reason":{"type":"string"},"calculationSnapshot":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},"evaluatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","createdAt","updatedAt","projectId","eventId","conversionAttributionId","participantId","programId","ruleId","termsVersionId","beneficiaryRole","allowanceId","outcome","reason","calculationSnapshot","evaluatedAt"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/reward-adjustments":{"get":{"operationId":"listRewardAdjustments","tags":["Management"],"description":"List the 100 newest reward adjustments (refunds, disputes, restorations). Needs the referrals:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"purchaseAdjustmentId":{"type":"string"},"rewardId":{"type":"string"},"purchaseId":{"type":"string"},"currency":{"type":"string"},"signedAmountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"calculationSnapshot":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["id","createdAt","updatedAt","projectId","purchaseAdjustmentId","rewardId","purchaseId","currency","signedAmountMinor","calculationSnapshot"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/rewards/{rewardId}/void":{"post":{"operationId":"voidReward","tags":["Management"],"description":"Void an earned Reward with a reason code and a reason. A void is final; the Reward stays in the history. A write applies at once. Needs the rewards:void key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"rewardId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoidRewardInput"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"voidId":{"type":"string"},"rewardId":{"type":"string"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string"},"actor":{"type":"string"},"voidedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["voidId","rewardId","reasonCode","reason","actor","voidedAt"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/rewards/{rewardId}/delivery/retry":{"post":{"operationId":"retryRewardDelivery","tags":["Management"],"description":"Make a failed RefRef delivery of a Reward due again. A write applies at once. Needs the rewards:fulfill key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"rewardId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetryRewardDeliveryInput"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"evaluationId":{"type":"string"},"participantId":{"type":"string"},"programId":{"type":"string"},"ruleId":{"type":"string"},"termsVersionId":{"type":"string"},"allowanceId":{"type":["string","null"]},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"beneficiaryParticipantId":{"type":"string"},"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"amountMinor":{"anyOf":[{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},{"type":"null"}]},"currency":{"type":["string","null"]},"currencyExponent":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"typedBenefitSnapshot":{"anyOf":[{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}},{"type":"null"}]},"purchaseId":{"type":["string","null"]},"void":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string"},"actor":{"type":"string"},"voidedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","reasonCode","reason","actor","voidedAt"]},{"type":"null"}]},"netAmountMinor":{"anyOf":[{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},{"type":"null"}]},"fulfillmentStatus":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"fulfillment":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string"}},"required":["id","externalReference","occurredAt","actor"]},{"type":"null"}]},"revocation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string"}},"required":["id","externalReference","occurredAt","actor"]},{"type":"null"}]},"delivery":{"anyOf":[{"type":"object","properties":{"method":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"status":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"reason":{"anyOf":[{"type":"string","enum":["awaiting_operator","awaiting_payout","missing_billing_id","connection_unavailable","provider_error","unsupported_currency","insufficient_balance","nothing_to_deliver","purchase_refunded","outcome_unknown","awaiting_payout_details","payout_blocked","awaiting_tax_form","awaiting_billing_profile","beneficiary_deleted","unsupported_quantity","no_subscription","ambiguous_subscription","subscription_has_discount","plan_not_higher","plan_mismatch","revocation_not_applied"]},{"type":"null"}]},"providerReference":{"type":["string","null"]},"connectionId":{"type":["string","null"]},"attemptCount":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastError":{"type":["string","null"]},"nextAttemptAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]},"grantDispatchedAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]},"revocationDispatchedAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]},"deliveredAmountMinor":{"anyOf":[{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},{"type":"null"}]},"targetPlan":{"type":["string","null"]},"planPeriods":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"revertDueAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]},"revertedAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]},"revertOutcome":{"anyOf":[{"type":"string","enum":["reverted","plan_changed_by_customer","subscription_ended"]},{"type":"null"}]}},"required":["method","status","reason","providerReference","connectionId","attemptCount","lastError","nextAttemptAt","grantDispatchedAt","revocationDispatchedAt","deliveredAmountMinor","targetPlan","planPeriods","revertDueAt","revertedAt","revertOutcome"]},{"type":"null"}]}},"required":["id","createdAt","updatedAt","projectId","evaluationId","participantId","programId","ruleId","termsVersionId","allowanceId","beneficiaryRole","beneficiaryParticipantId","benefitKind","amountMinor","currency","currencyExponent","typedBenefitSnapshot","purchaseId","void","netAmountMinor","fulfillmentStatus","fulfillment","revocation","delivery"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/partners":{"get":{"operationId":"listPartners","tags":["Management"],"description":"List the partners of a Project with their invitations and applications. Needs the partners:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"state":{"type":"string","enum":["invited","applied","declined","active","removed"]},"date":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"programId":{"type":"string"},"programName":{"type":["string","null"]},"name":{"type":["string","null"]},"email":{"type":["string","null"]},"partnerRequestId":{"type":["string","null"]},"enrollmentId":{"type":["string","null"]},"participantId":{"type":["string","null"]}},"required":["state","date","programId","programName","name","email","partnerRequestId","enrollmentId","participantId"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/partner-applications/{partnerRequestId}/approve":{"post":{"operationId":"approvePartnerApplication","tags":["Management"],"description":"Approve a partner application; the partner joins the Program. A write applies at once. Needs the partners:write key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"partnerRequestId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApprovePartnerApplicationInput"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"partnerRequestId":{"type":"string"},"programId":{"type":"string"},"participantId":{"type":"string"}},"required":["partnerRequestId","programId","participantId"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/partner-applications/{partnerRequestId}/decline":{"post":{"operationId":"declinePartnerApplication","tags":["Management"],"description":"Decline a partner application. A write applies at once. Needs the partners:write key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"partnerRequestId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeclinePartnerApplicationInput"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"partnerRequestId":{"type":"string"}},"required":["partnerRequestId"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/partner-invitations/{partnerRequestId}/revoke":{"post":{"operationId":"revokePartnerInvitation","tags":["Management"],"description":"Revoke an open partner invitation. A write applies at once. Needs the partners:write key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"partnerRequestId","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RevokePartnerInvitationInput"}}}},"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"object","properties":{"partnerRequestId":{"type":"string"}},"required":["partnerRequestId"]}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/connections":{"get":{"operationId":"listConnections","tags":["Management"],"description":"List the provider connections of a Project (billing sources and stores) with their state. No credentials are returned. Needs the integrations:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"provider":{"type":"string","enum":["dodo","paypal","manual","simulated","shopify","woocommerce","stripe","paddle","polar","revenuecat"]},"mode":{"type":"string","enum":["test","live"]},"label":{"type":"string"},"externalAccountId":{"type":["string","null"]},"capabilities":{"type":"array","items":{"type":"string","enum":["apply_credit","revoke_credit","issue_discount","revoke_discount","upgrade_plan","collect","disburse","tax_documents"]}},"status":{"type":"string","enum":["active","disabled","error"]},"lastCheckedAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]},"lastError":{"type":["string","null"]},"credential":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["api_key","oauth","restricted_key","webhook_secret"]},"hint":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["type","hint","createdAt"]},{"type":"null"}]},"webhook":{"anyOf":[{"type":"object","properties":{"path":{"type":"string"},"secretSet":{"type":"boolean"}},"required":["path","secretSet"]},{"type":"null"}]},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","projectId","provider","mode","label","externalAccountId","capabilities","status","lastCheckedAt","lastError","credential","webhook","createdAt","updatedAt"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/webhook-deliveries":{"get":{"operationId":"listWebhookDeliveries","tags":["Management"],"description":"List webhook deliveries newest first, 50 per page; filter by endpointId or state. Needs the webhooks:read key permission.","security":[{"WorkspaceApiKey":[]}],"parameters":[{"name":"offset","in":"query","schema":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"}},{"name":"endpointId","in":"query","schema":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},{"name":"state","in":"query","schema":{"type":"string","enum":["pending","succeeded","failed"]}},{"name":"projectId","in":"query","required":true,"schema":{"type":"string","minLength":1,"maxLength":128}}],"responses":{"200":{"description":"Success.","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","const":true},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"endpointId":{"type":"string"},"eventId":{"type":"string"},"eventType":{"type":"string","enum":["participant.created","referral.created","event.recorded","reward.earned","reward.voided","reward.fulfilled","reward.revoked","payout.paid","payout.failed","payout.returned"]},"subjectId":{"type":"string"},"state":{"type":"string","enum":["pending","succeeded","failed"]},"attemptCount":{"type":"integer","minimum":0,"maximum":9007199254740991},"nextAttemptAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"lastAttemptAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]},"lastStatusCode":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"lastError":{"type":["string","null"]}},"required":["id","createdAt","updatedAt","projectId","endpointId","eventId","eventType","subjectId","state","attemptCount","nextAttemptAt","lastAttemptAt","lastStatusCode","lastError"]}}},"required":["success","data"]}}}},"400":{"description":"The request does not match the contract.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"A missing, invalid, or unscoped API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"The key does not have the permission, or the Project is of the other environment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"No such record in a Project that the key reaches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"The change conflicts with the current state.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"responses":{"InvalidInput":{"description":"Invalid input or proof","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"UnknownEventType":{"description":"The event type is not built in, not a qualifying type of the Project, and not named by a benefit rule of the Project","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"InvalidQuery":{"description":"Invalid query","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Unauthenticated":{"description":"Authentication required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"ApiKeyRequired":{"description":"API key required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Forbidden":{"description":"The Widget token belongs to another Project, or it does not have the scope of the operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"EnvironmentMismatch":{"description":"ENVIRONMENT_MISMATCH. The API key and the Project have different environments (Sandbox or Live); use a key of the Project's environment","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFound":{"description":"Resource absent or outside authenticated Project ownership","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"NotFoundInScope":{"description":"Resource not found in authenticated scope","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"Conflict":{"description":"Immutable fact or enrollment conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"securitySchemes":{"WorkspaceApiKey":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"Workspace-owned Better Auth API key of one environment (Sandbox or Live); it authorizes the Projects of that environment in its Workspace. A Project of the other environment returns 403 ENVIRONMENT_MISMATCH. Never expose it in the browser."},"WidgetJWT":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"HS256 with typ refref-widget+jwt, iss and projectId equal to Project ID, aud refref-widget, sub the external ID of the participant, participantKind its kind (individual or group), mandatory iat and exp, lifetime at most 900 seconds. scope lists one or more Widget scopes separated by one space; widget:read gives Widget init and the payout details read, and widget:payout gives the payout details save, for example \"widget:read widget:payout\". A token without the scope of an operation gets 403. Signed by the Project backend with its secret."}},"schemas":{"sourceNamespaceRegistrationSchema":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"provider":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"accountKey":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},"required":["projectId","provider","accountKey"],"additionalProperties":false},"subscriptionFactIntakeSchema":{"oneOf":[{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceNamespaceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceDeliveryId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"actor":{"type":"object","properties":{"kind":{"type":"string","const":"individual"},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"externalSubscriptionId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"externalProviderSubscriptionId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"kind":{"type":"string","const":"subscription.started"},"commencementPhase":{"type":"string","enum":["trial","active"]}},"required":["projectId","sourceNamespaceId","participant","occurredAt","externalSubscriptionId","kind","commencementPhase"],"additionalProperties":false},{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceNamespaceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceDeliveryId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"actor":{"type":"object","properties":{"kind":{"type":"string","const":"individual"},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"externalSubscriptionId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"externalProviderSubscriptionId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceFactId":{"type":"string","minLength":1,"maxLength":525,"pattern":"\\S"},"kind":{"type":"string","enum":["subscription.activated","subscription.paused","subscription.resumed","subscription.cancelled"]}},"required":["projectId","sourceNamespaceId","participant","occurredAt","externalSubscriptionId","sourceFactId","kind"],"additionalProperties":false},{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceNamespaceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceDeliveryId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"actor":{"type":"object","properties":{"kind":{"type":"string","const":"individual"},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"externalSubscriptionId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"externalProviderSubscriptionId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceFactId":{"type":"string","minLength":1,"maxLength":525,"pattern":"\\S"},"kind":{"type":"string","const":"subscription.resource_mapped"},"predecessorSourceNamespaceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"predecessorExternalProviderSubscriptionId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"continuityEvidence":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/subscriptionFactIntakeSchema/$defs/__schema0"}}},"required":["projectId","sourceNamespaceId","participant","occurredAt","externalSubscriptionId","externalProviderSubscriptionId","sourceFactId","kind","predecessorSourceNamespaceId","predecessorExternalProviderSubscriptionId","continuityEvidence"],"additionalProperties":false}],"$defs":{"__schema0":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/subscriptionFactIntakeSchema/$defs/__schema0"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/subscriptionFactIntakeSchema/$defs/__schema0"}}]}}},"paidHistoryEvidenceIntakeSchema":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceNamespaceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceEvidenceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"supersedesEvidenceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"coverage":{"type":"object","properties":{"from":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"through":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"namespaceIds":{"minItems":1,"maxItems":10000,"type":"array","items":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},"complete":{"type":"boolean"},"purchaseKeys":{"maxItems":10000,"type":"array","items":{"type":"object","properties":{"namespaceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"resourceType":{"type":"string","enum":["invoice","order"]},"externalResourceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},"required":["namespaceId","resourceType","externalResourceId"],"additionalProperties":false}}},"required":["from","through","namespaceIds","complete","purchaseKeys"],"additionalProperties":false},"sourceSnapshot":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/paidHistoryEvidenceIntakeSchema/$defs/__schema0"}}},"required":["projectId","sourceNamespaceId","sourceEvidenceId","participant","coverage","sourceSnapshot"],"additionalProperties":false,"$defs":{"__schema0":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/paidHistoryEvidenceIntakeSchema/$defs/__schema0"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/paidHistoryEvidenceIntakeSchema/$defs/__schema0"}}]}}},"createBenefitRuleSchema":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"programId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"eventType":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"purpose":{"type":"string","enum":["primary","bonus"]},"name":{"type":"string","minLength":1,"maxLength":200},"terms":{"oneOf":[{"type":"object","properties":{"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"enabled":{"default":true,"type":"boolean"},"durationMode":{"default":"once","type":"string","enum":["once","fixed","lifetime"]},"durationMonths":{"type":"integer","minimum":1,"maximum":1200},"roundingPolicy":{"default":"half_up","type":"string","enum":["half_up"]},"refundPolicy":{"default":"proportional","type":"string","enum":["proportional"]},"maxRewardsPerBeneficiary":{"type":"integer","minimum":1,"maximum":1000000},"changeNote":{"type":"string","minLength":1,"maxLength":2000},"calculation":{"type":"string","const":"fixed"},"fixedAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":0,"maximum":6}},"required":["benefitKind","changeNote","calculation","fixedAmountMinor","currency","currencyExponent"],"additionalProperties":false},{"type":"object","properties":{"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"enabled":{"default":true,"type":"boolean"},"durationMode":{"default":"once","type":"string","enum":["once","fixed","lifetime"]},"durationMonths":{"type":"integer","minimum":1,"maximum":1200},"roundingPolicy":{"default":"half_up","type":"string","enum":["half_up"]},"refundPolicy":{"default":"proportional","type":"string","enum":["proportional"]},"maxRewardsPerBeneficiary":{"type":"integer","minimum":1,"maximum":1000000},"changeNote":{"type":"string","minLength":1,"maxLength":2000},"calculation":{"type":"string","const":"percentage"},"rateBps":{"type":"integer","minimum":0,"maximum":10000}},"required":["benefitKind","changeNote","calculation","rateBps"],"additionalProperties":false},{"type":"object","properties":{"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"enabled":{"default":true,"type":"boolean"},"durationMode":{"default":"once","type":"string","enum":["once","fixed","lifetime"]},"durationMonths":{"type":"integer","minimum":1,"maximum":1200},"roundingPolicy":{"default":"half_up","type":"string","enum":["half_up"]},"refundPolicy":{"default":"proportional","type":"string","enum":["proportional"]},"maxRewardsPerBeneficiary":{"type":"integer","minimum":1,"maximum":1000000},"changeNote":{"type":"string","minLength":1,"maxLength":2000},"calculation":{"type":"string","const":"percentage_discount"},"rateBps":{"type":"integer","minimum":0,"maximum":10000}},"required":["benefitKind","changeNote","calculation","rateBps"],"additionalProperties":false},{"type":"object","properties":{"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"enabled":{"default":true,"type":"boolean"},"durationMode":{"default":"once","type":"string","enum":["once","fixed","lifetime"]},"durationMonths":{"type":"integer","minimum":1,"maximum":1200},"roundingPolicy":{"default":"half_up","type":"string","enum":["half_up"]},"refundPolicy":{"default":"proportional","type":"string","enum":["proportional"]},"maxRewardsPerBeneficiary":{"type":"integer","minimum":1,"maximum":1000000},"changeNote":{"type":"string","minLength":1,"maxLength":2000},"calculation":{"type":"string","const":"fixed_quantity"},"quantity":{"type":"integer","minimum":1,"maximum":1000000000},"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"validityDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["benefitKind","changeNote","calculation","quantity","unitKey"],"additionalProperties":false}]}},"required":["projectId","programId","eventType","beneficiaryRole","purpose","name","terms"],"additionalProperties":false},"publishRewardTermsInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"terms":{"oneOf":[{"type":"object","properties":{"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"enabled":{"default":true,"type":"boolean"},"durationMode":{"default":"once","type":"string","enum":["once","fixed","lifetime"]},"durationMonths":{"type":"integer","minimum":1,"maximum":1200},"roundingPolicy":{"default":"half_up","type":"string","enum":["half_up"]},"refundPolicy":{"default":"proportional","type":"string","enum":["proportional"]},"maxRewardsPerBeneficiary":{"type":"integer","minimum":1,"maximum":1000000},"changeNote":{"type":"string","minLength":1,"maxLength":2000},"calculation":{"type":"string","const":"fixed"},"fixedAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":0,"maximum":6}},"required":["benefitKind","changeNote","calculation","fixedAmountMinor","currency","currencyExponent"],"additionalProperties":false},{"type":"object","properties":{"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"enabled":{"default":true,"type":"boolean"},"durationMode":{"default":"once","type":"string","enum":["once","fixed","lifetime"]},"durationMonths":{"type":"integer","minimum":1,"maximum":1200},"roundingPolicy":{"default":"half_up","type":"string","enum":["half_up"]},"refundPolicy":{"default":"proportional","type":"string","enum":["proportional"]},"maxRewardsPerBeneficiary":{"type":"integer","minimum":1,"maximum":1000000},"changeNote":{"type":"string","minLength":1,"maxLength":2000},"calculation":{"type":"string","const":"percentage"},"rateBps":{"type":"integer","minimum":0,"maximum":10000}},"required":["benefitKind","changeNote","calculation","rateBps"],"additionalProperties":false},{"type":"object","properties":{"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"enabled":{"default":true,"type":"boolean"},"durationMode":{"default":"once","type":"string","enum":["once","fixed","lifetime"]},"durationMonths":{"type":"integer","minimum":1,"maximum":1200},"roundingPolicy":{"default":"half_up","type":"string","enum":["half_up"]},"refundPolicy":{"default":"proportional","type":"string","enum":["proportional"]},"maxRewardsPerBeneficiary":{"type":"integer","minimum":1,"maximum":1000000},"changeNote":{"type":"string","minLength":1,"maxLength":2000},"calculation":{"type":"string","const":"percentage_discount"},"rateBps":{"type":"integer","minimum":0,"maximum":10000}},"required":["benefitKind","changeNote","calculation","rateBps"],"additionalProperties":false},{"type":"object","properties":{"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"enabled":{"default":true,"type":"boolean"},"durationMode":{"default":"once","type":"string","enum":["once","fixed","lifetime"]},"durationMonths":{"type":"integer","minimum":1,"maximum":1200},"roundingPolicy":{"default":"half_up","type":"string","enum":["half_up"]},"refundPolicy":{"default":"proportional","type":"string","enum":["proportional"]},"maxRewardsPerBeneficiary":{"type":"integer","minimum":1,"maximum":1000000},"changeNote":{"type":"string","minLength":1,"maxLength":2000},"calculation":{"type":"string","const":"fixed_quantity"},"quantity":{"type":"integer","minimum":1,"maximum":1000000000},"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"validityDays":{"type":"integer","minimum":1,"maximum":3650}},"required":["benefitKind","changeNote","calculation","quantity","unitKey"],"additionalProperties":false}]}},"required":["projectId","terms"],"additionalProperties":false},"purchaseAdjustmentInputSchema":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceNamespaceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"externalOperationId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"resourceType":{"type":"string","enum":["invoice","order"]},"externalResourceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"kind":{"type":"string","enum":["refund","dispute_loss","restoration"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"eligibleBaseDeltaMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"reversesExternalOperationId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"reason":{"type":"string","minLength":1,"maxLength":2000},"evidence":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/purchaseAdjustmentInputSchema/$defs/__schema0"}}},"required":["projectId","sourceNamespaceId","externalOperationId","resourceType","externalResourceId","kind","occurredAt","currency","eligibleBaseDeltaMinor","reason","evidence"],"additionalProperties":false,"$defs":{"__schema0":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"null"},{"type":"array","items":{"$ref":"#/components/schemas/purchaseAdjustmentInputSchema/$defs/__schema0"}},{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"$ref":"#/components/schemas/purchaseAdjustmentInputSchema/$defs/__schema0"}}]}}},"widgetInitRequestSchema":{"type":"object","properties":{"projectId":{"type":"string","minLength":1},"programId":{"type":"string","minLength":1}},"required":["projectId"],"additionalProperties":false},"enrollParticipantInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"programId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},"required":["projectId","participant","programId"],"additionalProperties":false},"endEnrollmentInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},"required":["projectId"],"additionalProperties":false},"createReferralCodeInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"programId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},"required":["projectId","participant","programId"],"additionalProperties":false},"createReferralLinkInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"programId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"slug":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$"}},"required":["projectId","participant","programId","slug"],"additionalProperties":false},"publishAttributionPolicyInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"effectiveAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"windowDays":{"default":90,"type":"number","const":90},"refereeMustBeNew":{"default":false,"type":"boolean"},"changeNote":{"type":"string","minLength":1,"maxLength":2000}},"required":["projectId","changeNote"],"additionalProperties":false},"HealthResponse":{"type":"object","properties":{"ok":{"type":"boolean"},"service":{"type":"string"},"checks":{"type":"object"}}},"ErrorResponse":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_ERROR","INVALID_REQUEST","NOT_FOUND","RATE_LIMIT_EXCEEDED","INTERNAL_SERVER_ERROR","AUTH_REQUIRED","FORBIDDEN","ENVIRONMENT_MISMATCH","CONFLICT","FACTS_CONFLICT","UNKNOWN_EVENT_TYPE"]},"message":{"type":"string"},"details":{"type":"array","items":{"type":"object","properties":{"path":{"type":"string"},"message":{"type":"string"}},"required":["path","message"],"additionalProperties":false}},"requestId":{"type":"string"}},"required":["code","message"],"additionalProperties":false}},"required":["error"],"additionalProperties":false,"description":"Every API error body. Each code has one status: VALIDATION_ERROR 400, INVALID_REQUEST 400, NOT_FOUND 404, RATE_LIMIT_EXCEEDED 429, INTERNAL_SERVER_ERROR 500, AUTH_REQUIRED 401, FORBIDDEN 403, ENVIRONMENT_MISMATCH 403, CONFLICT 409, FACTS_CONFLICT 409, UNKNOWN_EVENT_TYPE 422. A request that fails schema validation gets VALIDATION_ERROR, and details lists its field issues. A Fastify or Node.js 4xx error, such as a malformed JSON body or URL, keeps its own status with INVALID_REQUEST. requestId identifies the request; give it when you report a problem. A request that Node.js refuses before routing has no requestId. New codes can be added: handle an unknown code by its HTTP status. The message is for people."},"OperationResponse":{"type":"object","required":["success"],"properties":{"success":{"const":true}},"additionalProperties":true},"TrackResponse":{"type":"object","required":["success","eventId","participantId","processingState"],"properties":{"success":{"const":true},"eventId":{"type":"string"},"participantId":{"type":"string"},"processingState":{"enum":["pending","complete"]},"processingReason":{"description":"Why a pending Event waits. A complete Event has no reason.","enum":["awaiting_attribution","fact_in_future","subscription_origin_unresolved","reward_evaluation_pending","historical_attribution_pending","paid_history_incomplete","paid_history_requires_reconciliation","paid_anchor_unresolved","processing_error",null]},"identified":{"description":"Present only when the request had identify: whether the handle is now identified to the participant of the Event.","type":"boolean"}},"additionalProperties":true},"WidgetResponse":{"oneOf":[{"type":"object","properties":{"position":{"type":"string","enum":["bottom-right","bottom-left","top-right","top-left"]},"triggerText":{"type":"string"},"icon":{"type":"string","enum":["gift","heart","star","zap"]},"title":{"type":"string"},"subtitle":{"type":"string"},"logoUrl":{"type":"string"},"cssVariables":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"shareMessage":{"type":"string"},"enabledPlatforms":{"type":"object","properties":{"facebook":{"type":"boolean"},"twitter":{"type":"boolean"},"linkedin":{"type":"boolean"},"whatsapp":{"type":"boolean"},"email":{"type":"boolean"},"instagram":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["facebook","twitter","linkedin","whatsapp","email","instagram","telegram"],"additionalProperties":false},"referralLink":{"type":"string"},"productName":{"type":"string"},"participantId":{"type":"string","minLength":1},"referralLinks":{"type":"array","items":{"type":"object","properties":{"refCodeId":{"type":"string"},"refCode":{"type":"string"},"url":{"type":"string"}},"required":["refCodeId","refCode","url"],"additionalProperties":false}},"status":{"type":"string","const":"enrolled"},"enrollmentId":{"type":"string"},"programId":{"type":"string"}},"required":["position","triggerText","icon","title","subtitle","logoUrl","shareMessage","enabledPlatforms","referralLink","productName","participantId","referralLinks","status","enrollmentId","programId"],"additionalProperties":false},{"type":"object","properties":{"participantId":{"type":"string","minLength":1},"referralLinks":{"maxItems":0,"type":"array","items":{"type":"object","properties":{"refCodeId":{"type":"string"},"refCode":{"type":"string"},"url":{"type":"string"}},"required":["refCodeId","refCode","url"],"additionalProperties":false}},"status":{"type":"string","enum":["not_enrolled","not_applicable"]}},"required":["participantId","referralLinks","status"],"additionalProperties":false}],"description":"Both responses give the participantId of the participant that the Widget token names. Enrolled responses contain full presentation settings and canonical referral links. Not-enrolled responses have no links or enrollment."},"BenefitRulesResponse":{"type":"object","properties":{"success":{"const":true},"rules":{"type":"array","items":{"type":"object","additionalProperties":false,"required":["ruleId","eventType","initialEffectiveAt","beneficiaryRole"],"properties":{"ruleId":{"type":"string","minLength":1},"eventType":{"type":"string","minLength":1},"initialEffectiveAt":{"type":"string","minLength":1},"beneficiaryRole":{"type":"string","minLength":1}}}}}},"eventIntakeSchema":{"anyOf":[{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceNamespaceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceDeliveryId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"actor":{"type":"object","properties":{"kind":{"type":"string","const":"individual"},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"refCode":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"type":{"type":"string","const":"purchase"},"purchase":{"type":"object","properties":{"resourceType":{"type":"string","enum":["invoice","order"]},"externalResourceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceOrderIndex":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"externalSubscriptionId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"externalProviderSubscriptionId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"paidAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":0,"maximum":6},"paidAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"taxMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"commissionableAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"}},"required":["resourceType","externalResourceId","paidAt","currency","currencyExponent","paidAmountMinor","taxMinor","commissionableAmountMinor"],"additionalProperties":false}},"required":["projectId","sourceNamespaceId","participant","type","purchase"],"additionalProperties":false},{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceNamespaceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceDeliveryId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"actor":{"type":"object","properties":{"kind":{"type":"string","const":"individual"},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"identify":{"type":"object","properties":{"handle":{"type":"string","maxLength":4096}},"required":["handle"],"additionalProperties":false},"refCode":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"type":{"type":"string","const":"signup"},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"sourceEventId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},"required":["projectId","sourceNamespaceId","participant","type"],"additionalProperties":false},{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceNamespaceId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"sourceDeliveryId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"actor":{"type":"object","properties":{"kind":{"type":"string","const":"individual"},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"refCode":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"type":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"sourceEventId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},"required":["projectId","sourceNamespaceId","participant","type","occurredAt","sourceEventId"],"additionalProperties":false}]},"createCustomUnitSchema":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"name":{"type":"string","minLength":1,"maxLength":64},"namePlural":{"type":"string","minLength":1,"maxLength":64}},"required":["projectId","key","name"],"additionalProperties":false},"updateCustomUnitInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"name":{"type":"string","minLength":1,"maxLength":64},"namePlural":{"type":"string","minLength":1,"maxLength":64},"archived":{"type":"boolean"}},"required":["projectId"],"additionalProperties":false},"fulfillRewardInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"externalReference":{"type":"string","minLength":1,"maxLength":512},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["projectId"],"additionalProperties":false},"CustomUnitResponse":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"name":{"type":"string"},"namePlural":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"success":{"type":"boolean","const":true}},"required":["id","key","name","namePlural","archived","createdAt","updatedAt","success"],"additionalProperties":false},"CustomUnitsResponse":{"type":"object","properties":{"customUnits":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"name":{"type":"string"},"namePlural":{"type":"string"},"archived":{"type":"boolean"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"updatedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","key","name","namePlural","archived","createdAt","updatedAt"],"additionalProperties":false}},"success":{"type":"boolean","const":true}},"required":["customUnits","success"],"additionalProperties":false},"RewardResponse":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"programId":{"type":"string"},"ruleId":{"type":"string"},"termsVersionId":{"type":"string"},"eventId":{"type":"string"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"money":{"anyOf":[{"type":"object","properties":{"amountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"netAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["amountMinor","netAmountMinor","currency","currencyExponent"],"additionalProperties":false},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"rateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rateBps"],"additionalProperties":false},{"type":"null"}]},"custom":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customUnitId":{"type":"string"},"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"unitName":{"type":"string"},"unitNamePlural":{"type":"string"},"validityDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["quantity","customUnitId","unitKey","unitName","unitNamePlural","validityDays"],"additionalProperties":false},{"type":"null"}]},"earnedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"fulfillmentStatus":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"fulfillment":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"revocation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"delivery":{"type":"object","properties":{"method":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"status":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"reason":{"anyOf":[{"type":"string","enum":["awaiting_operator","awaiting_payout","missing_billing_id","connection_unavailable","provider_error","unsupported_currency","insufficient_balance","nothing_to_deliver","purchase_refunded","outcome_unknown","awaiting_payout_details","payout_blocked","awaiting_tax_form","awaiting_billing_profile","beneficiary_deleted","unsupported_quantity","no_subscription","ambiguous_subscription","subscription_has_discount","plan_not_higher","plan_mismatch","revocation_not_applied"]},{"type":"null"}]},"providerReference":{"type":["string","null"]}},"required":["method","status","reason","providerReference"],"additionalProperties":false},"void":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string"},"voidedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","reasonCode","reason","voidedAt"],"additionalProperties":false},{"type":"null"}]},"success":{"type":"boolean","const":true}},"required":["id","projectId","programId","ruleId","termsVersionId","eventId","beneficiaryRole","beneficiary","benefitKind","money","discount","custom","earnedAt","fulfillmentStatus","fulfillment","revocation","delivery","void","success"],"additionalProperties":false,"description":"A Reward with its fulfillment status (decision 0043). One of money, discount, and custom is set, as benefitKind says. A custom reward is a quantity of a custom unit. delivery.method says who delivers the Reward: your product grants operator and manual Rewards, and RefRef delivers the other methods."},"RewardsResponse":{"type":"object","properties":{"rewards":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"programId":{"type":"string"},"ruleId":{"type":"string"},"termsVersionId":{"type":"string"},"eventId":{"type":"string"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"money":{"anyOf":[{"type":"object","properties":{"amountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"netAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["amountMinor","netAmountMinor","currency","currencyExponent"],"additionalProperties":false},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"rateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rateBps"],"additionalProperties":false},{"type":"null"}]},"custom":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customUnitId":{"type":"string"},"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"unitName":{"type":"string"},"unitNamePlural":{"type":"string"},"validityDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["quantity","customUnitId","unitKey","unitName","unitNamePlural","validityDays"],"additionalProperties":false},{"type":"null"}]},"earnedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"fulfillmentStatus":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"fulfillment":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"revocation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"delivery":{"type":"object","properties":{"method":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"status":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"reason":{"anyOf":[{"type":"string","enum":["awaiting_operator","awaiting_payout","missing_billing_id","connection_unavailable","provider_error","unsupported_currency","insufficient_balance","nothing_to_deliver","purchase_refunded","outcome_unknown","awaiting_payout_details","payout_blocked","awaiting_tax_form","awaiting_billing_profile","beneficiary_deleted","unsupported_quantity","no_subscription","ambiguous_subscription","subscription_has_discount","plan_not_higher","plan_mismatch","revocation_not_applied"]},{"type":"null"}]},"providerReference":{"type":["string","null"]}},"required":["method","status","reason","providerReference"],"additionalProperties":false},"void":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string"},"voidedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","reasonCode","reason","voidedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["id","projectId","programId","ruleId","termsVersionId","eventId","beneficiaryRole","beneficiary","benefitKind","money","discount","custom","earnedAt","fulfillmentStatus","fulfillment","revocation","delivery","void"],"additionalProperties":false}},"next":{"description":"The cursor of the following page, or null.","type":["string","null"]},"success":{"type":"boolean","const":true}},"required":["rewards","next","success"],"additionalProperties":false},"upsertParticipantInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"name":{"anyOf":[{"type":"string","minLength":1,"maxLength":200},{"type":"null"}]},"email":{"anyOf":[{"type":"string","maxLength":320,"format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"type":"null"}]},"billingId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},"required":["projectId","participant"],"additionalProperties":false},"ParticipantResponse":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string"},"name":{"type":["string","null"]},"email":{"type":["string","null"]},"billingId":{"type":["string","null"]},"success":{"type":"boolean","const":true}},"required":["participantId","kind","externalId","name","email","billingId","success"],"additionalProperties":false,"description":"The participant that the body names, with its current external ID, name, email, and billing ID after the call."},"widgetPayoutDetailsRequestSchema":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"country":{"type":"string","pattern":"^[A-Z]{2}$"},"method":{"type":"string","const":"paypal"},"paypalEmail":{"type":"string","maxLength":254,"allOf":[{"pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},{"pattern":"^[^+\\-=@]"}]},"acceptTerms":{"type":"string","const":"2026-10"}},"required":["projectId","country","method","acceptTerms"],"additionalProperties":false},"WidgetPayoutDetailsResponse":{"type":"object","properties":{"eligible":{"type":"boolean"},"recipient":{"anyOf":[{"type":"object","properties":{"status":{"type":"string","enum":["active","blocked"]},"country":{"type":["string","null"]},"method":{"anyOf":[{"type":"object","properties":{"type":{"type":"string","enum":["paypal","bank_transfer"]},"maskedDestination":{"type":["string","null"]}},"required":["type","maskedDestination"],"additionalProperties":false},{"type":"null"}]},"termsVersion":{"type":["string","null"]},"termsAcceptedAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]},"taxStatus":{"type":"string","enum":["not_required","requested","on_file","expired"]}},"required":["status","country","method","termsVersion","termsAcceptedAt","taxStatus"],"additionalProperties":false},{"type":"null"}]},"offeredMethods":{"type":"array","items":{"type":"string","enum":["paypal","bank_transfer"]}},"termsVersion":{"type":"string"},"taxFormRequired":{"type":"boolean"},"canSave":{"type":"boolean"},"amounts":{"type":"object","properties":{"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"heldMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"payableMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"inProgressMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"paidMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"correctionsMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"}},"required":["currency","heldMinor","payableMinor","inProgressMinor","paidMinor","correctionsMinor"],"additionalProperties":false}},"required":["eligible","recipient","offeredMethods","termsVersion","taxFormRequired","canSave","amounts"],"additionalProperties":false,"description":"The cash payouts of the participant that the Widget token names, in the Project of the token. The Widget shows its payout details section only when eligible is true. recipient is null until the participant saves its details, and its method shows only a masked address. Amounts are signed decimal strings of minor units."},"createWebhookEndpointSchema":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"url":{"type":"string","maxLength":2048,"format":"uri"},"description":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"eventTypes":{"default":["participant.created","referral.created","event.recorded","reward.earned","reward.voided","reward.fulfilled","reward.revoked","payout.paid","payout.failed","payout.returned"],"minItems":1,"type":"array","items":{"type":"string","enum":["participant.created","referral.created","event.recorded","reward.earned","reward.voided","reward.fulfilled","reward.revoked","payout.paid","payout.failed","payout.returned"]}},"fulfillmentMode":{"default":"on_delivery","type":"string","enum":["on_delivery","explicit"]}},"required":["projectId","url"],"additionalProperties":false},"WebhookEventsResponse":{"type":"object","properties":{"events":{"type":"array","items":{"oneOf":[{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"participant.created"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"participant":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false}},"required":["participant"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"referral.created"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"referral":{"type":"object","properties":{"id":{"type":"string"},"programId":{"type":"string"},"referrer":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"referee":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"bindingEventId":{"type":["string","null"]},"bindingSubscriptionFactId":{"type":["string","null"]},"boundAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","programId","referrer","referee","bindingEventId","bindingSubscriptionFactId","boundAt"],"additionalProperties":false}},"required":["referral"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"event.recorded"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"event":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"participant":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"actor":{"anyOf":[{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},{"type":"null"}]},"sourceNamespaceId":{"type":"string"},"sourceEventId":{"type":"string"},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"purchase":{"anyOf":[{"type":"object","properties":{"resourceType":{"type":"string","enum":["invoice","order"]},"externalResourceId":{"type":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paidAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"taxMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"commissionableAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"}},"required":["resourceType","externalResourceId","currency","currencyExponent","paidAmountMinor","taxMinor","commissionableAmountMinor"],"additionalProperties":false},{"type":"null"}]}},"required":["id","type","participant","actor","sourceNamespaceId","sourceEventId","occurredAt","purchase"],"additionalProperties":false},"attribution":{"type":"object","properties":{"outcome":{"type":"string","enum":["attributed","unattributed"]},"reason":{"type":"string","enum":["predates_attribution_policy","predates_recorded_lead","recorded_lead_preserved","latest_eligible_touch","referral_code_on_fact","no_eligible_touch","self_touch_excluded","predates_subscription_commencement","subscription_origin_preserved","existing_customer_excluded","predates_source_namespace","participant_limit_paused","not_qualifying_type"]},"referralId":{"type":["string","null"]},"programId":{"type":["string","null"]},"referrer":{"anyOf":[{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},{"type":"null"}]}},"required":["outcome","reason","referralId","programId","referrer"],"additionalProperties":false}},"required":["event","attribution"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"reward.earned"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"reward":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"programId":{"type":"string"},"ruleId":{"type":"string"},"termsVersionId":{"type":"string"},"eventId":{"type":"string"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"money":{"anyOf":[{"type":"object","properties":{"amountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"netAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["amountMinor","netAmountMinor","currency","currencyExponent"],"additionalProperties":false},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"rateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rateBps"],"additionalProperties":false},{"type":"null"}]},"custom":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customUnitId":{"type":"string"},"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"unitName":{"type":"string"},"unitNamePlural":{"type":"string"},"validityDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["quantity","customUnitId","unitKey","unitName","unitNamePlural","validityDays"],"additionalProperties":false},{"type":"null"}]},"earnedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"fulfillmentStatus":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"fulfillment":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"revocation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"delivery":{"type":"object","properties":{"method":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"status":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"reason":{"anyOf":[{"type":"string","enum":["awaiting_operator","awaiting_payout","missing_billing_id","connection_unavailable","provider_error","unsupported_currency","insufficient_balance","nothing_to_deliver","purchase_refunded","outcome_unknown","awaiting_payout_details","payout_blocked","awaiting_tax_form","awaiting_billing_profile","beneficiary_deleted","unsupported_quantity","no_subscription","ambiguous_subscription","subscription_has_discount","plan_not_higher","plan_mismatch","revocation_not_applied"]},{"type":"null"}]},"providerReference":{"type":["string","null"]}},"required":["method","status","reason","providerReference"],"additionalProperties":false},"void":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string"},"voidedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","reasonCode","reason","voidedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["id","projectId","programId","ruleId","termsVersionId","eventId","beneficiaryRole","beneficiary","benefitKind","money","discount","custom","earnedAt","fulfillmentStatus","fulfillment","revocation","delivery","void"],"additionalProperties":false}},"required":["reward"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"reward.voided"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"reward":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"programId":{"type":"string"},"ruleId":{"type":"string"},"termsVersionId":{"type":"string"},"eventId":{"type":"string"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"money":{"anyOf":[{"type":"object","properties":{"amountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"netAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["amountMinor","netAmountMinor","currency","currencyExponent"],"additionalProperties":false},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"rateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rateBps"],"additionalProperties":false},{"type":"null"}]},"custom":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customUnitId":{"type":"string"},"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"unitName":{"type":"string"},"unitNamePlural":{"type":"string"},"validityDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["quantity","customUnitId","unitKey","unitName","unitNamePlural","validityDays"],"additionalProperties":false},{"type":"null"}]},"earnedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"fulfillmentStatus":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"fulfillment":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"revocation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"delivery":{"type":"object","properties":{"method":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"status":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"reason":{"anyOf":[{"type":"string","enum":["awaiting_operator","awaiting_payout","missing_billing_id","connection_unavailable","provider_error","unsupported_currency","insufficient_balance","nothing_to_deliver","purchase_refunded","outcome_unknown","awaiting_payout_details","payout_blocked","awaiting_tax_form","awaiting_billing_profile","beneficiary_deleted","unsupported_quantity","no_subscription","ambiguous_subscription","subscription_has_discount","plan_not_higher","plan_mismatch","revocation_not_applied"]},{"type":"null"}]},"providerReference":{"type":["string","null"]}},"required":["method","status","reason","providerReference"],"additionalProperties":false},"void":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string"},"voidedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","reasonCode","reason","voidedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["id","projectId","programId","ruleId","termsVersionId","eventId","beneficiaryRole","beneficiary","benefitKind","money","discount","custom","earnedAt","fulfillmentStatus","fulfillment","revocation","delivery","void"],"additionalProperties":false}},"required":["reward"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"reward.fulfilled"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"reward":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"programId":{"type":"string"},"ruleId":{"type":"string"},"termsVersionId":{"type":"string"},"eventId":{"type":"string"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"money":{"anyOf":[{"type":"object","properties":{"amountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"netAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["amountMinor","netAmountMinor","currency","currencyExponent"],"additionalProperties":false},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"rateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rateBps"],"additionalProperties":false},{"type":"null"}]},"custom":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customUnitId":{"type":"string"},"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"unitName":{"type":"string"},"unitNamePlural":{"type":"string"},"validityDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["quantity","customUnitId","unitKey","unitName","unitNamePlural","validityDays"],"additionalProperties":false},{"type":"null"}]},"earnedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"fulfillmentStatus":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"fulfillment":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"revocation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"delivery":{"type":"object","properties":{"method":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"status":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"reason":{"anyOf":[{"type":"string","enum":["awaiting_operator","awaiting_payout","missing_billing_id","connection_unavailable","provider_error","unsupported_currency","insufficient_balance","nothing_to_deliver","purchase_refunded","outcome_unknown","awaiting_payout_details","payout_blocked","awaiting_tax_form","awaiting_billing_profile","beneficiary_deleted","unsupported_quantity","no_subscription","ambiguous_subscription","subscription_has_discount","plan_not_higher","plan_mismatch","revocation_not_applied"]},{"type":"null"}]},"providerReference":{"type":["string","null"]}},"required":["method","status","reason","providerReference"],"additionalProperties":false},"void":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string"},"voidedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","reasonCode","reason","voidedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["id","projectId","programId","ruleId","termsVersionId","eventId","beneficiaryRole","beneficiary","benefitKind","money","discount","custom","earnedAt","fulfillmentStatus","fulfillment","revocation","delivery","void"],"additionalProperties":false}},"required":["reward"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"reward.revoked"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"reward":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"programId":{"type":"string"},"ruleId":{"type":"string"},"termsVersionId":{"type":"string"},"eventId":{"type":"string"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"money":{"anyOf":[{"type":"object","properties":{"amountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"netAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["amountMinor","netAmountMinor","currency","currencyExponent"],"additionalProperties":false},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"rateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rateBps"],"additionalProperties":false},{"type":"null"}]},"custom":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customUnitId":{"type":"string"},"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"unitName":{"type":"string"},"unitNamePlural":{"type":"string"},"validityDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["quantity","customUnitId","unitKey","unitName","unitNamePlural","validityDays"],"additionalProperties":false},{"type":"null"}]},"earnedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"fulfillmentStatus":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"fulfillment":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"revocation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"delivery":{"type":"object","properties":{"method":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"status":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"reason":{"anyOf":[{"type":"string","enum":["awaiting_operator","awaiting_payout","missing_billing_id","connection_unavailable","provider_error","unsupported_currency","insufficient_balance","nothing_to_deliver","purchase_refunded","outcome_unknown","awaiting_payout_details","payout_blocked","awaiting_tax_form","awaiting_billing_profile","beneficiary_deleted","unsupported_quantity","no_subscription","ambiguous_subscription","subscription_has_discount","plan_not_higher","plan_mismatch","revocation_not_applied"]},{"type":"null"}]},"providerReference":{"type":["string","null"]}},"required":["method","status","reason","providerReference"],"additionalProperties":false},"void":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string"},"voidedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","reasonCode","reason","voidedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["id","projectId","programId","ruleId","termsVersionId","eventId","beneficiaryRole","beneficiary","benefitKind","money","discount","custom","earnedAt","fulfillmentStatus","fulfillment","revocation","delivery","void"],"additionalProperties":false}},"required":["reward"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"payout.paid"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"payout":{"type":"object","properties":{"id":{"type":"string"},"method":{"type":"string","enum":["paypal","bank_transfer"]},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"amountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"rewards":{"type":"array","items":{"type":"object","properties":{"rewardId":{"type":"string"},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"amountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"}},"required":["rewardId","beneficiary","amountMinor"],"additionalProperties":false}},"failureReason":{"type":["string","null"]}},"required":["id","method","currency","amountMinor","rewards","failureReason"],"additionalProperties":false}},"required":["payout"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"payout.failed"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"payout":{"type":"object","properties":{"id":{"type":"string"},"method":{"type":"string","enum":["paypal","bank_transfer"]},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"amountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"rewards":{"type":"array","items":{"type":"object","properties":{"rewardId":{"type":"string"},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"amountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"}},"required":["rewardId","beneficiary","amountMinor"],"additionalProperties":false}},"failureReason":{"type":["string","null"]}},"required":["id","method","currency","amountMinor","rewards","failureReason"],"additionalProperties":false}},"required":["payout"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"payout.returned"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"payout":{"type":"object","properties":{"id":{"type":"string"},"method":{"type":"string","enum":["paypal","bank_transfer"]},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"amountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"rewards":{"type":"array","items":{"type":"object","properties":{"rewardId":{"type":"string"},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"amountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"}},"required":["rewardId","beneficiary","amountMinor"],"additionalProperties":false}},"failureReason":{"type":["string","null"]}},"required":["id","method","currency","amountMinor","rewards","failureReason"],"additionalProperties":false}},"required":["payout"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false}]}},"next":{"description":"The cursor of the following page, or null.","type":["string","null"]},"success":{"type":"boolean","const":true}},"required":["events","next","success"],"additionalProperties":false,"description":"Webhook events in commit order (decisions 0044 and 0052). A webhook delivery sends one event in this envelope, signed with the Standard Webhooks headers webhook-id, webhook-timestamp, and webhook-signature."},"WebhookEndpointResponse":{"type":"object","properties":{"endpoint":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"url":{"type":"string"},"description":{"type":["string","null"]},"eventTypes":{"type":"array","items":{"type":"string","enum":["participant.created","referral.created","event.recorded","reward.earned","reward.voided","reward.fulfilled","reward.revoked","payout.paid","payout.failed","payout.returned"]}},"apiVersion":{"type":"string","enum":["2026-10-04"]},"fulfillmentMode":{"type":"string","enum":["on_delivery","explicit"]},"enabled":{"type":"boolean"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","projectId","url","description","eventTypes","apiVersion","fulfillmentMode","enabled","createdAt"],"additionalProperties":false},"secret":{"type":"string"},"success":{"type":"boolean","const":true}},"required":["endpoint","secret","success"],"additionalProperties":false,"description":"The new endpoint and its signing secret (whsec_...). The secret shows only in this response."},"WebhookEndpointsResponse":{"type":"object","properties":{"endpoints":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"url":{"type":"string"},"description":{"type":["string","null"]},"eventTypes":{"type":"array","items":{"type":"string","enum":["participant.created","referral.created","event.recorded","reward.earned","reward.voided","reward.fulfilled","reward.revoked","payout.paid","payout.failed","payout.returned"]}},"apiVersion":{"type":"string","enum":["2026-10-04"]},"fulfillmentMode":{"type":"string","enum":["on_delivery","explicit"]},"enabled":{"type":"boolean"},"createdAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","projectId","url","description","eventTypes","apiVersion","fulfillmentMode","enabled","createdAt"],"additionalProperties":false}},"success":{"type":"boolean","const":true}},"required":["endpoints","success"],"additionalProperties":false},"WebhookEndpointDeletedResponse":{"type":"object","properties":{"id":{"type":"string"},"success":{"type":"boolean","const":true}},"required":["id","success"],"additionalProperties":false},"ParticipantCreatedEvent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"participant.created"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"participant":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false}},"required":["participant"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false,"description":"RefRef created a participant: a trusted call or a Widget token named one that the Project did not have, or a partner joined the Project. A partner has no externalId.","examples":[{"id":"wev_example","type":"participant.created","apiVersion":"2026-10-04","occurredAt":"2026-10-04T12:00:00.000Z","projectId":"prj_example","environment":"live","data":{"participant":{"participantId":"prt_example_referee","kind":"individual","externalId":"example-referee"}}}]},"ReferralCreatedEvent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"referral.created"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"referral":{"type":"object","properties":{"id":{"type":"string"},"programId":{"type":"string"},"referrer":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"referee":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"bindingEventId":{"type":["string","null"]},"bindingSubscriptionFactId":{"type":["string","null"]},"boundAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","programId","referrer","referee","bindingEventId","bindingSubscriptionFactId","boundAt"],"additionalProperties":false}},"required":["referral"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false,"description":"Attribution bound a referral: a referrer for the referee of an Event or a Subscription.","examples":[{"id":"wev_example","type":"referral.created","apiVersion":"2026-10-04","occurredAt":"2026-10-04T12:00:00.000Z","projectId":"prj_example","environment":"live","data":{"referral":{"id":"ref_example","programId":"prg_example","referrer":{"participantId":"prt_example_referrer","kind":"individual","externalId":"example-referrer"},"referee":{"participantId":"prt_example_referee","kind":"individual","externalId":"example-referee"},"bindingEventId":"evt_example_signup","bindingSubscriptionFactId":null,"boundAt":"2026-10-04T12:00:00.000Z"}}}]},"EventRecordedEvent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"event.recorded"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"event":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"participant":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"actor":{"anyOf":[{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},{"type":"null"}]},"sourceNamespaceId":{"type":"string"},"sourceEventId":{"type":"string"},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"purchase":{"anyOf":[{"type":"object","properties":{"resourceType":{"type":"string","enum":["invoice","order"]},"externalResourceId":{"type":"string"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paidAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"taxMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"commissionableAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"}},"required":["resourceType","externalResourceId","currency","currencyExponent","paidAmountMinor","taxMinor","commissionableAmountMinor"],"additionalProperties":false},{"type":"null"}]}},"required":["id","type","participant","actor","sourceNamespaceId","sourceEventId","occurredAt","purchase"],"additionalProperties":false},"attribution":{"type":"object","properties":{"outcome":{"type":"string","enum":["attributed","unattributed"]},"reason":{"type":"string","enum":["predates_attribution_policy","predates_recorded_lead","recorded_lead_preserved","latest_eligible_touch","referral_code_on_fact","no_eligible_touch","self_touch_excluded","predates_subscription_commencement","subscription_origin_preserved","existing_customer_excluded","predates_source_namespace","participant_limit_paused","not_qualifying_type"]},"referralId":{"type":["string","null"]},"programId":{"type":["string","null"]},"referrer":{"anyOf":[{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},{"type":"null"}]}},"required":["outcome","reason","referralId","programId","referrer"],"additionalProperties":false}},"required":["event","attribution"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false,"description":"RefRef recorded an Event with its attribution decision.","examples":[{"id":"wev_example","type":"event.recorded","apiVersion":"2026-10-04","occurredAt":"2026-10-04T12:00:00.000Z","projectId":"prj_example","environment":"live","data":{"event":{"id":"evt_example_purchase","type":"purchase","participant":{"participantId":"prt_example_referee","kind":"individual","externalId":"example-referee"},"actor":null,"sourceNamespaceId":"sns_example","sourceEventId":"invoice:in_123","occurredAt":"2026-10-04T12:00:00.000Z","purchase":{"resourceType":"invoice","externalResourceId":"in_123","currency":"USD","currencyExponent":2,"paidAmountMinor":"4900","taxMinor":"0","commissionableAmountMinor":"4900"}},"attribution":{"outcome":"attributed","reason":"recorded_lead_preserved","referralId":"ref_example","programId":"prg_example","referrer":{"participantId":"prt_example_referrer","kind":"individual","externalId":"example-referrer"}}}}]},"RewardEarnedEvent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"reward.earned"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"reward":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"programId":{"type":"string"},"ruleId":{"type":"string"},"termsVersionId":{"type":"string"},"eventId":{"type":"string"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"money":{"anyOf":[{"type":"object","properties":{"amountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"netAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["amountMinor","netAmountMinor","currency","currencyExponent"],"additionalProperties":false},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"rateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rateBps"],"additionalProperties":false},{"type":"null"}]},"custom":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customUnitId":{"type":"string"},"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"unitName":{"type":"string"},"unitNamePlural":{"type":"string"},"validityDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["quantity","customUnitId","unitKey","unitName","unitNamePlural","validityDays"],"additionalProperties":false},{"type":"null"}]},"earnedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"fulfillmentStatus":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"fulfillment":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"revocation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"delivery":{"type":"object","properties":{"method":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"status":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"reason":{"anyOf":[{"type":"string","enum":["awaiting_operator","awaiting_payout","missing_billing_id","connection_unavailable","provider_error","unsupported_currency","insufficient_balance","nothing_to_deliver","purchase_refunded","outcome_unknown","awaiting_payout_details","payout_blocked","awaiting_tax_form","awaiting_billing_profile","beneficiary_deleted","unsupported_quantity","no_subscription","ambiguous_subscription","subscription_has_discount","plan_not_higher","plan_mismatch","revocation_not_applied"]},{"type":"null"}]},"providerReference":{"type":["string","null"]}},"required":["method","status","reason","providerReference"],"additionalProperties":false},"void":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string"},"voidedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","reasonCode","reason","voidedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["id","projectId","programId","ruleId","termsVersionId","eventId","beneficiaryRole","beneficiary","benefitKind","money","discount","custom","earnedAt","fulfillmentStatus","fulfillment","revocation","delivery","void"],"additionalProperties":false}},"required":["reward"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false,"description":"A participant earned a Reward.","examples":[{"id":"wev_example","type":"reward.earned","apiVersion":"2026-10-04","occurredAt":"2026-10-04T12:00:00.000Z","projectId":"prj_example","environment":"live","data":{"reward":{"id":"rwd_example","projectId":"prj_example","programId":"prg_example","ruleId":"brl_example","termsVersionId":"rtv_example","eventId":"evt_example_purchase","beneficiaryRole":"referrer","beneficiary":{"participantId":"prt_example_referrer","kind":"individual","externalId":"example-referrer"},"benefitKind":"custom","money":null,"discount":null,"custom":{"quantity":500,"customUnitId":"cun_example","unitKey":"storage_mb","unitName":"MB of storage","unitNamePlural":"MB of storage","validityDays":null},"earnedAt":"2026-10-04T12:00:00.000Z","fulfillmentStatus":"pending","fulfillment":null,"revocation":null,"delivery":{"method":"operator","status":"pending","reason":"awaiting_operator","providerReference":null},"void":null}}}]},"RewardVoidedEvent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"reward.voided"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"reward":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"programId":{"type":"string"},"ruleId":{"type":"string"},"termsVersionId":{"type":"string"},"eventId":{"type":"string"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"money":{"anyOf":[{"type":"object","properties":{"amountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"netAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["amountMinor","netAmountMinor","currency","currencyExponent"],"additionalProperties":false},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"rateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rateBps"],"additionalProperties":false},{"type":"null"}]},"custom":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customUnitId":{"type":"string"},"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"unitName":{"type":"string"},"unitNamePlural":{"type":"string"},"validityDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["quantity","customUnitId","unitKey","unitName","unitNamePlural","validityDays"],"additionalProperties":false},{"type":"null"}]},"earnedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"fulfillmentStatus":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"fulfillment":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"revocation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"delivery":{"type":"object","properties":{"method":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"status":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"reason":{"anyOf":[{"type":"string","enum":["awaiting_operator","awaiting_payout","missing_billing_id","connection_unavailable","provider_error","unsupported_currency","insufficient_balance","nothing_to_deliver","purchase_refunded","outcome_unknown","awaiting_payout_details","payout_blocked","awaiting_tax_form","awaiting_billing_profile","beneficiary_deleted","unsupported_quantity","no_subscription","ambiguous_subscription","subscription_has_discount","plan_not_higher","plan_mismatch","revocation_not_applied"]},{"type":"null"}]},"providerReference":{"type":["string","null"]}},"required":["method","status","reason","providerReference"],"additionalProperties":false},"void":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string"},"voidedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","reasonCode","reason","voidedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["id","projectId","programId","ruleId","termsVersionId","eventId","beneficiaryRole","beneficiary","benefitKind","money","discount","custom","earnedAt","fulfillmentStatus","fulfillment","revocation","delivery","void"],"additionalProperties":false}},"required":["reward"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false,"description":"An operator voided a Reward.","examples":[{"id":"wev_example","type":"reward.voided","apiVersion":"2026-10-04","occurredAt":"2026-10-04T12:00:00.000Z","projectId":"prj_example","environment":"live","data":{"reward":{"id":"rwd_example","projectId":"prj_example","programId":"prg_example","ruleId":"brl_example","termsVersionId":"rtv_example","eventId":"evt_example_purchase","beneficiaryRole":"referrer","beneficiary":{"participantId":"prt_example_referrer","kind":"individual","externalId":"example-referrer"},"benefitKind":"custom","money":null,"discount":null,"custom":{"quantity":500,"customUnitId":"cun_example","unitKey":"storage_mb","unitName":"MB of storage","unitNamePlural":"MB of storage","validityDays":null},"earnedAt":"2026-10-04T12:00:00.000Z","fulfillmentStatus":"cancelled","fulfillment":null,"revocation":null,"delivery":{"method":"operator","status":"cancelled","reason":null,"providerReference":null},"void":{"id":"rvd_example","reasonCode":"fraud","reason":"Duplicate account.","voidedAt":"2026-10-04T12:00:00.000Z"}}}}]},"RewardFulfilledEvent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"reward.fulfilled"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"reward":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"programId":{"type":"string"},"ruleId":{"type":"string"},"termsVersionId":{"type":"string"},"eventId":{"type":"string"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"money":{"anyOf":[{"type":"object","properties":{"amountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"netAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["amountMinor","netAmountMinor","currency","currencyExponent"],"additionalProperties":false},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"rateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rateBps"],"additionalProperties":false},{"type":"null"}]},"custom":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customUnitId":{"type":"string"},"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"unitName":{"type":"string"},"unitNamePlural":{"type":"string"},"validityDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["quantity","customUnitId","unitKey","unitName","unitNamePlural","validityDays"],"additionalProperties":false},{"type":"null"}]},"earnedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"fulfillmentStatus":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"fulfillment":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"revocation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"delivery":{"type":"object","properties":{"method":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"status":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"reason":{"anyOf":[{"type":"string","enum":["awaiting_operator","awaiting_payout","missing_billing_id","connection_unavailable","provider_error","unsupported_currency","insufficient_balance","nothing_to_deliver","purchase_refunded","outcome_unknown","awaiting_payout_details","payout_blocked","awaiting_tax_form","awaiting_billing_profile","beneficiary_deleted","unsupported_quantity","no_subscription","ambiguous_subscription","subscription_has_discount","plan_not_higher","plan_mismatch","revocation_not_applied"]},{"type":"null"}]},"providerReference":{"type":["string","null"]}},"required":["method","status","reason","providerReference"],"additionalProperties":false},"void":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string"},"voidedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","reasonCode","reason","voidedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["id","projectId","programId","ruleId","termsVersionId","eventId","beneficiaryRole","beneficiary","benefitKind","money","discount","custom","earnedAt","fulfillmentStatus","fulfillment","revocation","delivery","void"],"additionalProperties":false}},"required":["reward"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false,"description":"A Reward was fulfilled: your product, the Console, a webhook answer, or RefRef delivered it.","examples":[{"id":"wev_example","type":"reward.fulfilled","apiVersion":"2026-10-04","occurredAt":"2026-10-04T12:00:00.000Z","projectId":"prj_example","environment":"live","data":{"reward":{"id":"rwd_example","projectId":"prj_example","programId":"prg_example","ruleId":"brl_example","termsVersionId":"rtv_example","eventId":"evt_example_purchase","beneficiaryRole":"referrer","beneficiary":{"participantId":"prt_example_referrer","kind":"individual","externalId":"example-referrer"},"benefitKind":"custom","money":null,"discount":null,"custom":{"quantity":500,"customUnitId":"cun_example","unitKey":"storage_mb","unitName":"MB of storage","unitNamePlural":"MB of storage","validityDays":null},"earnedAt":"2026-10-04T12:00:00.000Z","fulfillmentStatus":"fulfilled","fulfillment":{"id":"rfl_example","externalReference":"grant_77","occurredAt":"2026-10-04T12:00:00.000Z","actor":"api"},"revocation":null,"delivery":{"method":"operator","status":"fulfilled","reason":null,"providerReference":null},"void":null}}}]},"RewardRevokedEvent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"reward.revoked"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"reward":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"programId":{"type":"string"},"ruleId":{"type":"string"},"termsVersionId":{"type":"string"},"eventId":{"type":"string"},"beneficiaryRole":{"type":"string","enum":["referrer","referee","subject"]},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"benefitKind":{"type":"string","enum":["cash","credit","discount","custom"]},"money":{"anyOf":[{"type":"object","properties":{"amountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"netAmountMinor":{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["amountMinor","netAmountMinor","currency","currencyExponent"],"additionalProperties":false},{"type":"null"}]},"discount":{"anyOf":[{"type":"object","properties":{"rateBps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["rateBps"],"additionalProperties":false},{"type":"null"}]},"custom":{"anyOf":[{"type":"object","properties":{"quantity":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"customUnitId":{"type":"string"},"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"unitName":{"type":"string"},"unitNamePlural":{"type":"string"},"validityDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["quantity","customUnitId","unitKey","unitName","unitNamePlural","validityDays"],"additionalProperties":false},{"type":"null"}]},"earnedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"fulfillmentStatus":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"fulfillment":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"revocation":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"externalReference":{"type":["string","null"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"actor":{"type":"string","enum":["console","api","webhook","system"]}},"required":["id","externalReference","occurredAt","actor"],"additionalProperties":false},{"type":"null"}]},"delivery":{"type":"object","properties":{"method":{"type":"string","enum":["operator","billing_credit","billing_discount","billing_plan_upgrade","manual","payout"]},"status":{"type":"string","enum":["pending","in_progress","fulfilled","failed","cancelled","revocation_pending","revoked"]},"reason":{"anyOf":[{"type":"string","enum":["awaiting_operator","awaiting_payout","missing_billing_id","connection_unavailable","provider_error","unsupported_currency","insufficient_balance","nothing_to_deliver","purchase_refunded","outcome_unknown","awaiting_payout_details","payout_blocked","awaiting_tax_form","awaiting_billing_profile","beneficiary_deleted","unsupported_quantity","no_subscription","ambiguous_subscription","subscription_has_discount","plan_not_higher","plan_mismatch","revocation_not_applied"]},{"type":"null"}]},"providerReference":{"type":["string","null"]}},"required":["method","status","reason","providerReference"],"additionalProperties":false},"void":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string"},"voidedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["id","reasonCode","reason","voidedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["id","projectId","programId","ruleId","termsVersionId","eventId","beneficiaryRole","beneficiary","benefitKind","money","discount","custom","earnedAt","fulfillmentStatus","fulfillment","revocation","delivery","void"],"additionalProperties":false}},"required":["reward"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false,"description":"Your product took back a voided Reward that it granted.","examples":[{"id":"wev_example","type":"reward.revoked","apiVersion":"2026-10-04","occurredAt":"2026-10-04T12:00:00.000Z","projectId":"prj_example","environment":"live","data":{"reward":{"id":"rwd_example","projectId":"prj_example","programId":"prg_example","ruleId":"brl_example","termsVersionId":"rtv_example","eventId":"evt_example_purchase","beneficiaryRole":"referrer","beneficiary":{"participantId":"prt_example_referrer","kind":"individual","externalId":"example-referrer"},"benefitKind":"custom","money":null,"discount":null,"custom":{"quantity":500,"customUnitId":"cun_example","unitKey":"storage_mb","unitName":"MB of storage","unitNamePlural":"MB of storage","validityDays":null},"earnedAt":"2026-10-04T12:00:00.000Z","fulfillmentStatus":"revoked","fulfillment":{"id":"rfl_example","externalReference":"grant_77","occurredAt":"2026-10-04T12:00:00.000Z","actor":"api"},"revocation":{"id":"rrv_example","externalReference":null,"occurredAt":"2026-10-04T12:00:00.000Z","actor":"api"},"delivery":{"method":"operator","status":"revoked","reason":null,"providerReference":null},"void":{"id":"rvd_example","reasonCode":"fraud","reason":"Duplicate account.","voidedAt":"2026-10-04T12:00:00.000Z"}}}}]},"PayoutPaidEvent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"payout.paid"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"payout":{"type":"object","properties":{"id":{"type":"string"},"method":{"type":"string","enum":["paypal","bank_transfer"]},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"amountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"rewards":{"type":"array","items":{"type":"object","properties":{"rewardId":{"type":"string"},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"amountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"}},"required":["rewardId","beneficiary","amountMinor"],"additionalProperties":false}},"failureReason":{"type":["string","null"]}},"required":["id","method","currency","amountMinor","rewards","failureReason"],"additionalProperties":false}},"required":["payout"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false,"description":"A payout paid cash Rewards of the Project.","examples":[{"id":"wev_example","type":"payout.paid","apiVersion":"2026-10-04","occurredAt":"2026-10-04T12:00:00.000Z","projectId":"prj_example","environment":"live","data":{"payout":{"id":"pdb_example","method":"paypal","currency":"USD","amountMinor":"2500","rewards":[{"rewardId":"rwd_example","beneficiary":{"participantId":"prt_example_referrer","kind":"individual","externalId":"example-referrer"},"amountMinor":"2500"}],"failureReason":null}}}]},"PayoutFailedEvent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"payout.failed"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"payout":{"type":"object","properties":{"id":{"type":"string"},"method":{"type":"string","enum":["paypal","bank_transfer"]},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"amountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"rewards":{"type":"array","items":{"type":"object","properties":{"rewardId":{"type":"string"},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"amountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"}},"required":["rewardId","beneficiary","amountMinor"],"additionalProperties":false}},"failureReason":{"type":["string","null"]}},"required":["id","method","currency","amountMinor","rewards","failureReason"],"additionalProperties":false}},"required":["payout"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false,"description":"A payout failed before payment. Its Rewards wait for the next payout.","examples":[{"id":"wev_example","type":"payout.failed","apiVersion":"2026-10-04","occurredAt":"2026-10-04T12:00:00.000Z","projectId":"prj_example","environment":"live","data":{"payout":{"id":"pdb_example","method":"paypal","currency":"USD","amountMinor":"2500","rewards":[{"rewardId":"rwd_example","beneficiary":{"participantId":"prt_example_referrer","kind":"individual","externalId":"example-referrer"},"amountMinor":"2500"}],"failureReason":"The account is closed."}}}]},"PayoutReturnedEvent":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string","const":"payout.returned"},"apiVersion":{"type":"string","enum":["2026-10-04"]},"occurredAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"projectId":{"type":"string"},"environment":{"type":"string","enum":["sandbox","live"]},"data":{"type":"object","properties":{"payout":{"type":"object","properties":{"id":{"type":"string"},"method":{"type":"string","enum":["paypal","bank_transfer"]},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"amountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"},"rewards":{"type":"array","items":{"type":"object","properties":{"rewardId":{"type":"string"},"beneficiary":{"type":"object","properties":{"participantId":{"type":"string"},"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":["string","null"]}},"required":["participantId","kind","externalId"],"additionalProperties":false},"amountMinor":{"type":"string","pattern":"^(0|-?[1-9][0-9]*)$"}},"required":["rewardId","beneficiary","amountMinor"],"additionalProperties":false}},"failureReason":{"type":["string","null"]}},"required":["id","method","currency","amountMinor","rewards","failureReason"],"additionalProperties":false}},"required":["payout"],"additionalProperties":false}},"required":["id","type","apiVersion","occurredAt","projectId","environment","data"],"additionalProperties":false,"description":"The provider returned a payout, before or after its payment. The next payout pays its Rewards again.","examples":[{"id":"wev_example","type":"payout.returned","apiVersion":"2026-10-04","occurredAt":"2026-10-04T12:00:00.000Z","projectId":"prj_example","environment":"live","data":{"payout":{"id":"pdb_example","method":"paypal","currency":"USD","amountMinor":"2500","rewards":[{"rewardId":"rwd_example","beneficiary":{"participantId":"prt_example_referrer","kind":"individual","externalId":"example-referrer"},"amountMinor":"2500"}],"failureReason":"The payment came back."}}}]},"identifySchema":{"anyOf":[{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"handle":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"observedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["projectId","handle","participant"],"additionalProperties":false},{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"handle":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"reference":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"expiresAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["key"],"additionalProperties":false},"observedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["projectId","handle","reference"],"additionalProperties":false},{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"reference":{"type":"object","properties":{"key":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"expiresAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]}},"required":["key"],"additionalProperties":false},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false}},"required":["projectId","reference","participant"],"additionalProperties":false}]},"captureSchema":{"type":"object","properties":{"handoffToken":{"type":"string","minLength":1,"maxLength":16384},"handle":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"}},"required":["handoffToken"],"additionalProperties":false},"IdentifyResponse":{"anyOf":[{"type":"object","properties":{"success":{"type":"boolean","const":true},"identificationId":{"type":"string"},"handle":{"type":"string"},"identifiedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"participantId":{"type":"string"}},"required":["success","identificationId","handle","identifiedAt","participantId"],"additionalProperties":false},{"type":"object","properties":{"success":{"type":"boolean","const":true},"identificationId":{"type":"string"},"handle":{"type":"string"},"identifiedAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"reference":{"type":"object","properties":{"key":{"type":"string"},"expiresAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"resolvedAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]}},"required":["key","expiresAt","resolvedAt"],"additionalProperties":false}},"required":["success","identificationId","handle","identifiedAt","reference"],"additionalProperties":false},{"type":"object","properties":{"success":{"type":"boolean","const":true},"reference":{"type":"object","properties":{"key":{"type":"string"},"expiresAt":{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},"resolvedAt":{"anyOf":[{"type":"string","allOf":[{"pattern":"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"},{"pattern":"T\\d{2}:\\d{2}:\\d{2}(?:\\.\\d{1,3})?Z$"}]},{"type":"null"}]}},"required":["key","expiresAt","resolvedAt"],"additionalProperties":false},"participantId":{"type":"string"}},"required":["success","reference","participantId"],"additionalProperties":false}],"description":"The result of the form of the body: for { handle, participant }, the identification of the handle to the participant (identificationId, handle, identifiedAt, participantId); for { handle, reference }, the identification of the handle to the reference (identificationId, handle, identifiedAt, reference); for { reference, participant }, the resolved reference and its participant (reference, participantId), with no identification. A repeated call with the same target returns the first result."},"CaptureResponse":{"type":"object","properties":{"handle":{"type":"string"}},"required":["handle"],"additionalProperties":false,"description":"The handle of the browser. Keep it in a first-party cookie and send it with POST /v1/identify or the identify field of a signup."},"rekeyParticipantInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"participant":{"type":"object","properties":{"kind":{"type":"string","enum":["individual","group"]},"externalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["kind","externalId"],"additionalProperties":false},"newExternalId":{"type":"string","minLength":1,"maxLength":512,"allOf":[{"pattern":"\\S"},{"pattern":"^(?!deleted:)"}]}},"required":["projectId","participant","newExternalId"],"additionalProperties":false},"SetQualifyingEventTypesInput":{"type":"object","properties":{"qualifyingEventTypes":{"minItems":1,"type":"array","items":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"}},"projectId":{"type":"string","minLength":1,"maxLength":128}},"required":["qualifyingEventTypes","projectId"],"additionalProperties":false},"CreateProgramInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","minLength":1,"maxLength":100},"kind":{"default":"referral","type":"string","enum":["referral","loyalty"]},"landingPageUrl":{"type":"string","pattern":"^https?:\\/\\/[^/?#\\s]+"},"widgetConfig":{"type":"object","properties":{"position":{"type":"string","enum":["bottom-right","bottom-left","top-right","top-left"]},"triggerText":{"type":"string"},"icon":{"type":"string","enum":["gift","heart","star","zap"]},"title":{"type":"string"},"subtitle":{"type":"string"},"logoUrl":{"type":"string"},"cssVariables":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"shareMessage":{"type":"string"},"enabledPlatforms":{"type":"object","properties":{"facebook":{"type":"boolean"},"twitter":{"type":"boolean"},"linkedin":{"type":"boolean"},"whatsapp":{"type":"boolean"},"email":{"type":"boolean"},"instagram":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["facebook","twitter","linkedin","whatsapp","email","instagram","telegram"]},"referralLink":{"type":"string"},"productName":{"type":"string"}}},"primaryColor":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}$"},"partnerApplicationsOpen":{"type":"boolean"},"rules":{"maxItems":20,"type":"array","items":{"type":"object","properties":{"eventType":{"type":"string"},"beneficiaryRole":{"type":"string"},"purpose":{"type":"string"},"name":{"type":"string"},"terms":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{}}},"required":["eventType","beneficiaryRole","purpose","name","terms"],"additionalProperties":false}}},"required":["projectId","name","landingPageUrl"],"additionalProperties":false},"UpdateProgramInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":128},"name":{"type":"string","minLength":1,"maxLength":100},"config":{"type":"object","properties":{"schemaVersion":{"type":"number","const":1},"brandConfig":{"type":"object","properties":{"primaryColor":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}$"},"landingPageUrl":{"type":"string","pattern":"^https?:\\/\\/[^/?#\\s]+"}}},"widgetConfig":{"type":"object","properties":{"position":{"type":"string","enum":["bottom-right","bottom-left","top-right","top-left"]},"triggerText":{"type":"string"},"icon":{"type":"string","enum":["gift","heart","star","zap"]},"title":{"type":"string"},"subtitle":{"type":"string"},"logoUrl":{"type":"string"},"cssVariables":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}},"shareMessage":{"type":"string"},"enabledPlatforms":{"type":"object","properties":{"facebook":{"type":"boolean"},"twitter":{"type":"boolean"},"linkedin":{"type":"boolean"},"whatsapp":{"type":"boolean"},"email":{"type":"boolean"},"instagram":{"type":"boolean"},"telegram":{"type":"boolean"}},"required":["facebook","twitter","linkedin","whatsapp","email","instagram","telegram"]},"referralLink":{"type":"string"},"productName":{"type":"string"}}},"partnerApplicationsOpen":{"type":"boolean"}},"additionalProperties":false}},"required":["projectId"],"additionalProperties":false},"RenameBenefitRuleInput":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"projectId":{"type":"string","minLength":1,"maxLength":128}},"required":["name","projectId"],"additionalProperties":false},"PublishRefereeOfferInput":{"type":"object","properties":{"terms":{"type":"object","properties":{"enabled":{"default":true,"type":"boolean"},"calculation":{"type":"string","enum":["percentage","fixed"]},"rateBps":{"default":null,"anyOf":[{"type":"integer","minimum":1,"maximum":10000},{"type":"null"}]},"amountMinor":{"default":null,"anyOf":[{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},{"type":"null"}]},"currency":{"type":"string","pattern":"^[A-Z]{3}$"},"currencyExponent":{"type":"integer","minimum":0,"maximum":6},"minimumSubtotalMinor":{"default":null,"anyOf":[{"type":"string","pattern":"^(0|[1-9][0-9]*)$"},{"type":"null"}]},"validityDays":{"type":"integer","minimum":1,"maximum":3650},"combinesWithProductDiscounts":{"default":false,"type":"boolean"},"combinesWithOrderDiscounts":{"default":false,"type":"boolean"},"combinesWithShippingDiscounts":{"default":false,"type":"boolean"},"changeNote":{"type":"string","minLength":1,"maxLength":2000}},"required":["calculation","currency","currencyExponent","validityDays","changeNote"],"additionalProperties":false},"projectId":{"type":"string","minLength":1,"maxLength":128}},"required":["terms","projectId"],"additionalProperties":false},"UpdateDeliverySettingsInput":{"type":"object","properties":{"holdDays":{"type":"integer","minimum":0,"maximum":365},"cashMethod":{"type":"string","enum":["payout","manual"]},"creditMethod":{"type":"string","enum":["operator","billing_credit","manual"]},"discountMethod":{"type":"string","enum":["operator","billing_discount","manual"]},"customMethod":{"type":"string","enum":["operator","billing_plan_upgrade","manual"]},"planUpgrades":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"unitKey":{"type":"string","pattern":"^[a-z][a-z0-9_]{0,63}$"},"plan":{"type":"string","minLength":1,"maxLength":255},"periods":{"type":"integer","minimum":1,"maximum":12}},"required":["unitKey","plan","periods"],"additionalProperties":false}},"projectId":{"type":"string","minLength":1,"maxLength":128}},"required":["projectId"],"additionalProperties":false},"VoidRewardInput":{"type":"object","properties":{"operationKey":{"type":"string","minLength":1,"maxLength":512,"pattern":"\\S"},"reasonCode":{"type":"string","enum":["fraud","duplicate","operator_error","other"]},"reason":{"type":"string","minLength":1,"maxLength":2000},"projectId":{"type":"string","minLength":1,"maxLength":128}},"required":["operationKey","reasonCode","reason","projectId"],"additionalProperties":false},"RetryRewardDeliveryInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":128}},"required":["projectId"],"additionalProperties":false},"ApprovePartnerApplicationInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":128}},"required":["projectId"],"additionalProperties":false},"DeclinePartnerApplicationInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":128}},"required":["projectId"],"additionalProperties":false},"RevokePartnerInvitationInput":{"type":"object","properties":{"projectId":{"type":"string","minLength":1,"maxLength":128}},"required":["projectId"],"additionalProperties":false}}},"webhooks":{"participant.created":{"post":{"operationId":"participantCreatedWebhook","description":"RefRef created a participant: a trusted call or a Widget token named one that the Project did not have, or a partner joined the Project. A partner has no externalId. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to participant.created, and retries for about 72 hours until the endpoint answers 2xx.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"The event ID. Every delivery of an event has the same one; deduplicate on it.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when RefRef signed the request. Refuse an old timestamp.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"One v1, for each active secret, separated by spaces, of ... The key is the base64 text after whsec_ in the endpoint secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipantCreatedEvent"}}}},"responses":{"2XX":{"description":"Received."}}}},"referral.created":{"post":{"operationId":"referralCreatedWebhook","description":"Attribution bound a referral: a referrer for the referee of an Event or a Subscription. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to referral.created, and retries for about 72 hours until the endpoint answers 2xx.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"The event ID. Every delivery of an event has the same one; deduplicate on it.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when RefRef signed the request. Refuse an old timestamp.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"One v1, for each active secret, separated by spaces, of ... The key is the base64 text after whsec_ in the endpoint secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferralCreatedEvent"}}}},"responses":{"2XX":{"description":"Received."}}}},"event.recorded":{"post":{"operationId":"eventRecordedWebhook","description":"RefRef recorded an Event with its attribution decision. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to event.recorded, and retries for about 72 hours until the endpoint answers 2xx.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"The event ID. Every delivery of an event has the same one; deduplicate on it.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when RefRef signed the request. Refuse an old timestamp.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"One v1, for each active secret, separated by spaces, of ... The key is the base64 text after whsec_ in the endpoint secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventRecordedEvent"}}}},"responses":{"2XX":{"description":"Received."}}}},"reward.earned":{"post":{"operationId":"rewardEarnedWebhook","description":"A participant earned a Reward. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to reward.earned, and retries for about 72 hours until the endpoint answers 2xx.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"The event ID. Every delivery of an event has the same one; deduplicate on it.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when RefRef signed the request. Refuse an old timestamp.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"One v1, for each active secret, separated by spaces, of ... The key is the base64 text after whsec_ in the endpoint secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardEarnedEvent"}}}},"responses":{"2XX":{"description":"Received. On an on_delivery endpoint, a 202 only acknowledges the Reward; another 2xx also records its fulfillment."}}}},"reward.voided":{"post":{"operationId":"rewardVoidedWebhook","description":"An operator voided a Reward. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to reward.voided, and retries for about 72 hours until the endpoint answers 2xx.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"The event ID. Every delivery of an event has the same one; deduplicate on it.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when RefRef signed the request. Refuse an old timestamp.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"One v1, for each active secret, separated by spaces, of ... The key is the base64 text after whsec_ in the endpoint secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardVoidedEvent"}}}},"responses":{"2XX":{"description":"Received."}}}},"reward.fulfilled":{"post":{"operationId":"rewardFulfilledWebhook","description":"A Reward was fulfilled: your product, the Console, a webhook answer, or RefRef delivered it. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to reward.fulfilled, and retries for about 72 hours until the endpoint answers 2xx.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"The event ID. Every delivery of an event has the same one; deduplicate on it.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when RefRef signed the request. Refuse an old timestamp.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"One v1, for each active secret, separated by spaces, of ... The key is the base64 text after whsec_ in the endpoint secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardFulfilledEvent"}}}},"responses":{"2XX":{"description":"Received."}}}},"reward.revoked":{"post":{"operationId":"rewardRevokedWebhook","description":"Your product took back a voided Reward that it granted. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to reward.revoked, and retries for about 72 hours until the endpoint answers 2xx.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"The event ID. Every delivery of an event has the same one; deduplicate on it.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when RefRef signed the request. Refuse an old timestamp.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"One v1, for each active secret, separated by spaces, of ... The key is the base64 text after whsec_ in the endpoint secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RewardRevokedEvent"}}}},"responses":{"2XX":{"description":"Received."}}}},"payout.paid":{"post":{"operationId":"payoutPaidWebhook","description":"A payout paid cash Rewards of the Project. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to payout.paid, and retries for about 72 hours until the endpoint answers 2xx.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"The event ID. Every delivery of an event has the same one; deduplicate on it.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when RefRef signed the request. Refuse an old timestamp.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"One v1, for each active secret, separated by spaces, of ... The key is the base64 text after whsec_ in the endpoint secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutPaidEvent"}}}},"responses":{"2XX":{"description":"Received."}}}},"payout.failed":{"post":{"operationId":"payoutFailedWebhook","description":"A payout failed before payment. Its Rewards wait for the next payout. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to payout.failed, and retries for about 72 hours until the endpoint answers 2xx.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"The event ID. Every delivery of an event has the same one; deduplicate on it.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when RefRef signed the request. Refuse an old timestamp.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"One v1, for each active secret, separated by spaces, of ... The key is the base64 text after whsec_ in the endpoint secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutFailedEvent"}}}},"responses":{"2XX":{"description":"Received."}}}},"payout.returned":{"post":{"operationId":"payoutReturnedWebhook","description":"The provider returned a payout, before or after its payment. The next payout pays its Rewards again. RefRef POSTs the event to each enabled endpoint of the Project that subscribes to payout.returned, and retries for about 72 hours until the endpoint answers 2xx.","parameters":[{"name":"webhook-id","in":"header","required":true,"description":"The event ID. Every delivery of an event has the same one; deduplicate on it.","schema":{"type":"string"}},{"name":"webhook-timestamp","in":"header","required":true,"description":"Unix seconds when RefRef signed the request. Refuse an old timestamp.","schema":{"type":"string"}},{"name":"webhook-signature","in":"header","required":true,"description":"One v1, for each active secret, separated by spaces, of ... The key is the base64 text after whsec_ in the endpoint secret.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayoutReturnedEvent"}}}},"responses":{"2XX":{"description":"Received."}}}}}},"proxyUrl":"$undefined"},"document":"./openapi.yaml","operations":[{"method":"get","path":"/health","tags":["Health"]}],"showDescription":true}]}]]}]

Get Health

Response BodyCopy Anchor Link

200application/json

503

Response Body

`application/json`