Revenues

Update a Revenue

patch/api/revenues/{id}

Request

  • Base URL: https://hellosafe.com
  • URL: https://hellosafe.com/api/revenues/{id}
  • Auth: OAuth 2 (password, token URL /api//openapi-auth)

Request body

externalReferenceIdstring

Reference id from the external source (e.g. Chapka lead id, partner conversion id, click id). Used to de-duplicate and reconcile.

type'brokerage' | 'lead_gen' | 'cpc' | 'affiliate'

How this revenue is earned. Drives whether a commission rate applies.

partnerstring

ID of the partners

subscriptionstring

ID of the subscriptions

valuenumber

Real profit for this conversion, in EUR (decimal, e.g. 12.50). Converted to EUR via the FX quote rate when the source currency is not EUR. Set to 0 when the underlying sale is refunded.

commissionRateUsednumber nullable

The partner commission rate (%) applied to compute this revenue, snapshotted at creation time. Empty for fixed-price types (cpc, lead_gen).

landingPagestring nullable

Full landing-page URL of the linked subscription (auto-derived, not stored). Filterable in the list view — use the "contains" operator to isolate a marketing-attribution param, e.g. contains "gad_source".

deletedAtstring nullable

Response

Revenue object

idstring required
externalReferenceIdstring required

Reference id from the external source (e.g. Chapka lead id, partner conversion id, click id). Used to de-duplicate and reconcile.

type'brokerage' | 'lead_gen' | 'cpc' | 'affiliate' required

How this revenue is earned. Drives whether a commission rate applies.

valuenumber required

Real profit for this conversion, in EUR (decimal, e.g. 12.50). Converted to EUR via the FX quote rate when the source currency is not EUR. Set to 0 when the underlying sale is refunded.

commissionRateUsednumber nullable

The partner commission rate (%) applied to compute this revenue, snapshotted at creation time. Empty for fixed-price types (cpc, lead_gen).

landingPagestring nullable

Full landing-page URL of the linked subscription (auto-derived, not stored). Filterable in the list view — use the "contains" operator to isolate a marketing-attribution param, e.g. contains "gad_source".

updatedAtstring required
createdAtstring required
deletedAtstring nullable

Changes

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