Skip to main content
GET
/
advertising
/
api
/
v1
/
revenue-share
/
{organization_id}
/
{share_id}
Revenue share detail
curl --request GET \
  --url https://www.closient.com/advertising/api/v1/revenue-share/{organization_id}/{share_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "period_start": "2023-12-25",
  "period_end": "2023-12-25",
  "gross_revenue": "<string>",
  "platform_fee": "<string>",
  "retailer_share": "<string>",
  "platform_fee_rate": "<string>",
  "status": "CALCULATED",
  "metadata": {},
  "paid_at": "2023-11-07T05:31:56Z",
  "stripe_transfer_id": ""
}

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
organization_id
string<shortuuid>
required

UUID of the organization.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
​
share_id
string<shortuuid>
required

UUID of the revenue share record.

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

200 - application/json

OK

​
id
string<shortuuid>
required

URL-safe 22-character shortuuid encoding of the row's UUID primary key. Stable across the row's lifetime; suitable for sharing in URLs, log lines, and external SDK clients. Accepted on input as either the shortuuid form or the canonical UUID form (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
​
period_start
string<date>
required

First day of the billing period.

​
period_end
string<date>
required

Last day of the billing period.

​
gross_revenue
string
required

Total billable ad revenue in USD.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
platform_fee
string
required

Platform fee amount in USD.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
retailer_share
string
required

Amount payable to the retailer in USD.

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
platform_fee_rate
string
required

Platform fee rate (0.00-1.00).

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
status
enum<string>
required

Current status of this revenue share record.

Available options:
CALCULATED,
APPROVED,
PAID,
DISPUTED
​
metadata
Metadata · object

Developer-attached key/value data attached to this object. Up to 50 keys; key max 40 chars, value max 500 chars.

​
paid_at
string<date-time> | null

When the payment was disbursed.

​
stripe_transfer_id
string
default:""

Stripe transfer ID if paid.