> ## Documentation Index
> Fetch the complete documentation index at: https://docs.launchpointhq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Report spend per program

> What each visible program cost you through Launchpoint: one row for each program, sorted by spend. Pass `programId` to report one program.

`spend` is `deliverySpend` plus `adRoyaltySpend`:

- `deliverySpend` is the price of the program's delivery. Under a signed CPM contract it is the delivered views at the contract CPM. Without a CPM contract it is creator cost plus your platform fee (your take rate). For an Ads program it is the cost of sourcing creators plus that fee.
- `adRoyaltySpend` is the royalty fee of the ads that run the program's media. It already contains the creator share that `GET /programs/{programId}/ads` reports, so do not add that share again. Money you pay the ad platform is not included.

Views past a contract's commitment keep the price of the last contract; the commitment does not cap `spend`. This is the cost of delivery, not a record of cash payments or wallet debits. Use `spend` or `spendCents`, not both: each amount is returned in dollars and in cents.

**Do not add an Ads program to an organic program.** Each row has `kind`. Organic delivery and Ads sourcing are different purchases. `summary` covers every program in the report, not only the current page. Its spend amounts are `null` when the report has an Ads program and a program of another kind; sum the rows of one kind instead.

**Creator pay.** `paid`, `paidOffPlatform`, `awaiting`, and `tracking` are what the program's creators earned. If you pay a platform fee on creator pay, this money is the cost inside `deliverySpend`. Never add it to `spend`, and do not add your own direct creator payments either: `paidOffPlatform` is already inside. These fields are `null` if you have a CPM, fixed-fee, or itemized contract with Launchpoint, because you pay the contract price, not creator pay.

**Date ranges.** `fromDate` and `toDate` include both days and are New York days (`timeZone`). Without them the report covers all time.

- `deliverySpend` covers the views that occurred on those days. Under a CPM contract each view is charged on the day it occurred, at the rate of the contract that took it, so ranges that touch add up to the all-time amount. Without a contract, the program's charge is spread over its view days in proportion to views.
- `adRoyaltySpend` covers the ad delivery of those days.
- For an Ads program, sourcing cost uses the publish day of the post it pays for.
- `undatedSpend` is delivery that has no day. It is in no date range. It is part of `deliverySpend` and `spend` only when you set no dates.
- The creator pay fields select posts by their publish day.

**Changed.** Before this version, a date range selected posts by their publish day and counted all their spend. It now counts the delivery of the days in the range.

**Before you compute a cost per customer.** Spend is counted on the day the views occurred, and a purchase can follow days later. Use a range that ended at least as long ago as your usual time from view to purchase. A contract with a CPM range can change the amount of past days while that contract is still in progress, because its rate follows creator cost. Amounts can also change as views and earnings update.

This is different from `GET /payouts`, which lists money that left your own wallet.




## OpenAPI

````yaml /api-reference/openapi.json get /payouts/spend
openapi: 3.0.4
info:
  title: Launchpoint Public API
  version: 1.0.0
  description: >-
    **Private preview.** The Launchpoint Public API is in private preview and
    available only to trusted partners we work with directly. Access is not
    self-serve. Email hi@launchpointhq.com to ask about access.


    REST API for Launchpoint brands and agencies. Use an API key in the
    `x-api-key` header to authenticate.


    ## Requirements

    - Public API access must be enabled for the company. During private preview,
    access is limited to trusted partners.

    - Create and manage API keys in Dashboard → Settings → Developer.


    ## Creator privacy

    - Responses never include creator email addresses. Creator phone numbers are
    null when no number is stored or the workspace does not have access to
    creator contact details.


    ## Rate limits

    - Default: **200 requests per minute** per API key.

    - Approved partner accounts: **400 requests per minute**.

    - Every response includes `X-RateLimit-Limit`, `X-RateLimit-Remaining`, and
    `X-RateLimit-Reset`. Requests over the limit return `429`.


    ## Errors

    - Errors use `{ "error": "<message>" }` with the matching HTTP status. Some
    endpoints also include a `code`.


    ## Timestamps

    - Timestamps are Unix timestamps in milliseconds unless a field says
    otherwise.


    ## Pagination

    - Most list endpoints accept `page` and `limit` and return `{ data, page,
    total }`. Some also return `totalPages`.

    - `scope=company` is the default. A parent agency key can pass
    `scope=agency` on supported routes to include its own data and linked
    brands.
servers:
  - url: https://dashboard.launchpointhq.com/api/v1
    description: Live API server
security:
  - apiKeyAuth: []
tags:
  - name: Deals
    description: Public creator opportunities across Launchpoint
  - name: Programs
    description: Programs and campaign management
  - name: Posts
    description: Posts and social content
  - name: Analytics
    description: KPIs and performance metrics
  - name: Payouts
    description: Payouts, balances, and pending creator funds
  - name: Contracts
    description: Contracts and creator agreements
  - name: Creators
    description: Creator profiles and metrics
  - name: Applications
    description: Creator applications to Canvas programs
  - name: Messages
    description: Read and send creator messages
  - name: Onboarding
    description: 'Creator onboarding: status, messages, and proof review'
  - name: Media review
    description: >-
      Review the media creators send before they post: queue, status, approve,
      and reject
paths:
  /payouts/spend:
    get:
      tags:
        - Payouts
      summary: Report spend per program
      description: >
        What each visible program cost you through Launchpoint: one row for each
        program, sorted by spend. Pass `programId` to report one program.


        `spend` is `deliverySpend` plus `adRoyaltySpend`:


        - `deliverySpend` is the price of the program's delivery. Under a signed
        CPM contract it is the delivered views at the contract CPM. Without a
        CPM contract it is creator cost plus your platform fee (your take rate).
        For an Ads program it is the cost of sourcing creators plus that fee.

        - `adRoyaltySpend` is the royalty fee of the ads that run the program's
        media. It already contains the creator share that `GET
        /programs/{programId}/ads` reports, so do not add that share again.
        Money you pay the ad platform is not included.


        Views past a contract's commitment keep the price of the last contract;
        the commitment does not cap `spend`. This is the cost of delivery, not a
        record of cash payments or wallet debits. Use `spend` or `spendCents`,
        not both: each amount is returned in dollars and in cents.


        **Do not add an Ads program to an organic program.** Each row has
        `kind`. Organic delivery and Ads sourcing are different purchases.
        `summary` covers every program in the report, not only the current page.
        Its spend amounts are `null` when the report has an Ads program and a
        program of another kind; sum the rows of one kind instead.


        **Creator pay.** `paid`, `paidOffPlatform`, `awaiting`, and `tracking`
        are what the program's creators earned. If you pay a platform fee on
        creator pay, this money is the cost inside `deliverySpend`. Never add it
        to `spend`, and do not add your own direct creator payments either:
        `paidOffPlatform` is already inside. These fields are `null` if you have
        a CPM, fixed-fee, or itemized contract with Launchpoint, because you pay
        the contract price, not creator pay.


        **Date ranges.** `fromDate` and `toDate` include both days and are New
        York days (`timeZone`). Without them the report covers all time.


        - `deliverySpend` covers the views that occurred on those days. Under a
        CPM contract each view is charged on the day it occurred, at the rate of
        the contract that took it, so ranges that touch add up to the all-time
        amount. Without a contract, the program's charge is spread over its view
        days in proportion to views.

        - `adRoyaltySpend` covers the ad delivery of those days.

        - For an Ads program, sourcing cost uses the publish day of the post it
        pays for.

        - `undatedSpend` is delivery that has no day. It is in no date range. It
        is part of `deliverySpend` and `spend` only when you set no dates.

        - The creator pay fields select posts by their publish day.


        **Changed.** Before this version, a date range selected posts by their
        publish day and counted all their spend. It now counts the delivery of
        the days in the range.


        **Before you compute a cost per customer.** Spend is counted on the day
        the views occurred, and a purchase can follow days later. Use a range
        that ended at least as long ago as your usual time from view to
        purchase. A contract with a CPM range can change the amount of past days
        while that contract is still in progress, because its rate follows
        creator cost. Amounts can also change as views and earnings update.


        This is different from `GET /payouts`, which lists money that left your
        own wallet.
      parameters:
        - $ref: '#/components/parameters/ScopeParam'
        - in: query
          name: page
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Pagination page number
        - in: query
          name: limit
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          description: Programs to return per page
        - in: query
          name: programId
          schema:
            type: string
            format: uuid
          description: Narrow the report to one program
        - in: query
          name: fromDate
          schema:
            type: string
            format: date
          description: Count delivery on or after this New York day (YYYY-MM-DD)
        - in: query
          name: toDate
          schema:
            type: string
            format: date
          description: Count delivery on or before this New York day (YYYY-MM-DD)
      responses:
        '200':
          description: Program spend returned successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        programId:
                          type: string
                        programName:
                          type: string
                        status:
                          type: string
                          enum:
                            - draft
                            - active
                            - paused
                            - completed
                            - archived
                        kind:
                          type: string
                          description: Program kind, such as `ugc` or `ads`
                        currency:
                          type: string
                          enum:
                            - usd
                        spend:
                          type: number
                          description: deliverySpend + adRoyaltySpend, in dollars
                        spendCents:
                          type: integer
                          description: deliverySpend + adRoyaltySpend, in cents
                        deliverySpend:
                          type: number
                          description: >-
                            Price of the program's delivery: views at the
                            contract CPM, or creator cost plus the platform fee,
                            in dollars
                        deliverySpendCents:
                          type: integer
                          description: >-
                            Price of the program's delivery: views at the
                            contract CPM, or creator cost plus the platform fee,
                            in cents
                        adRoyaltySpend:
                          type: number
                          description: >-
                            Royalty fee of the ads that run the program's media,
                            in dollars
                        adRoyaltySpendCents:
                          type: integer
                          description: >-
                            Royalty fee of the ads that run the program's media,
                            in cents
                        undatedSpend:
                          type: number
                          description: >-
                            Delivery that has no day; part of deliverySpend and
                            spend only when no dates are set, in dollars
                        undatedSpendCents:
                          type: integer
                          description: >-
                            Delivery that has no day; part of deliverySpend and
                            spend only when no dates are set, in cents
                        paid:
                          type: number
                          description: >-
                            Money sent to creators through Launchpoint; null for
                            a contract customer, in dollars
                          nullable: true
                        paidCents:
                          type: integer
                          description: >-
                            Money sent to creators through Launchpoint; null for
                            a contract customer, in cents
                          nullable: true
                        paidOffPlatform:
                          type: number
                          description: >-
                            Money the brand paid creators directly, outside
                            Launchpoint; null for a contract customer, in
                            dollars
                          nullable: true
                        paidOffPlatformCents:
                          type: integer
                          description: >-
                            Money the brand paid creators directly, outside
                            Launchpoint; null for a contract customer, in cents
                          nullable: true
                        awaiting:
                          type: number
                          description: >-
                            Money held for creators that is past its pay date;
                            null for a contract customer, in dollars
                          nullable: true
                        awaitingCents:
                          type: integer
                          description: >-
                            Money held for creators that is past its pay date;
                            null for a contract customer, in cents
                          nullable: true
                        tracking:
                          type: number
                          description: >-
                            Money held for creators that is still inside its
                            view-tracking window; null for a contract customer,
                            in dollars
                          nullable: true
                        trackingCents:
                          type: integer
                          description: >-
                            Money held for creators that is still inside its
                            view-tracking window; null for a contract customer,
                            in cents
                          nullable: true
                  page:
                    type: integer
                  limit:
                    type: integer
                  total:
                    type: integer
                  totalPages:
                    type: integer
                  fromDate:
                    type: string
                    nullable: true
                  toDate:
                    type: string
                    nullable: true
                  timeZone:
                    type: string
                    description: Time zone of the date range and of each day
                    enum:
                      - America/New_York
                  summary:
                    type: object
                    properties:
                      programCount:
                        type: integer
                        description: Programs in the whole report, not only this page
                      currency:
                        type: string
                        enum:
                          - usd
                      spend:
                        type: number
                        description: >-
                          deliverySpend + adRoyaltySpend; null when the report
                          has an Ads program and a program of another kind, in
                          dollars
                        nullable: true
                      spendCents:
                        type: integer
                        description: >-
                          deliverySpend + adRoyaltySpend; null when the report
                          has an Ads program and a program of another kind, in
                          cents
                        nullable: true
                      deliverySpend:
                        type: number
                        description: >-
                          Price of the program's delivery: views at the contract
                          CPM, or creator cost plus the platform fee; null when
                          the report has an Ads program and a program of another
                          kind, in dollars
                        nullable: true
                      deliverySpendCents:
                        type: integer
                        description: >-
                          Price of the program's delivery: views at the contract
                          CPM, or creator cost plus the platform fee; null when
                          the report has an Ads program and a program of another
                          kind, in cents
                        nullable: true
                      adRoyaltySpend:
                        type: number
                        description: >-
                          Royalty fee of the ads that run the program's media;
                          null when the report has an Ads program and a program
                          of another kind, in dollars
                        nullable: true
                      adRoyaltySpendCents:
                        type: integer
                        description: >-
                          Royalty fee of the ads that run the program's media;
                          null when the report has an Ads program and a program
                          of another kind, in cents
                        nullable: true
                      undatedSpend:
                        type: number
                        description: >-
                          Delivery that has no day; part of deliverySpend and
                          spend only when no dates are set; null when the report
                          has an Ads program and a program of another kind, in
                          dollars
                        nullable: true
                      undatedSpendCents:
                        type: integer
                        description: >-
                          Delivery that has no day; part of deliverySpend and
                          spend only when no dates are set; null when the report
                          has an Ads program and a program of another kind, in
                          cents
                        nullable: true
                      paid:
                        type: number
                        description: >-
                          Money sent to creators through Launchpoint; null for a
                          contract customer, in dollars
                        nullable: true
                      paidCents:
                        type: integer
                        description: >-
                          Money sent to creators through Launchpoint; null for a
                          contract customer, in cents
                        nullable: true
                      paidOffPlatform:
                        type: number
                        description: >-
                          Money the brand paid creators directly, outside
                          Launchpoint; null for a contract customer, in dollars
                        nullable: true
                      paidOffPlatformCents:
                        type: integer
                        description: >-
                          Money the brand paid creators directly, outside
                          Launchpoint; null for a contract customer, in cents
                        nullable: true
                      awaiting:
                        type: number
                        description: >-
                          Money held for creators that is past its pay date;
                          null for a contract customer, in dollars
                        nullable: true
                      awaitingCents:
                        type: integer
                        description: >-
                          Money held for creators that is past its pay date;
                          null for a contract customer, in cents
                        nullable: true
                      tracking:
                        type: number
                        description: >-
                          Money held for creators that is still inside its
                          view-tracking window; null for a contract customer, in
                          dollars
                        nullable: true
                      trackingCents:
                        type: integer
                        description: >-
                          Money held for creators that is still inside its
                          view-tracking window; null for a contract customer, in
                          cents
                        nullable: true
        '400':
          description: Invalid filters, such as fromDate after toDate
        '401':
          description: API key is invalid or missing
        '429':
          description: Request rate limit exceeded
        '500':
          description: Server error
components:
  parameters:
    ScopeParam:
      in: query
      name: scope
      required: false
      schema:
        type: string
        enum:
          - company
          - agency
        default: company
      description: >-
        Choose the data scope. `company` (default) limits results to the API key
        company's data. `agency` includes the parent agency and its linked
        brands. `scope=agency` requires a parent agency key; other keys receive
        `403`.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key created in Dashboard → Settings → Developer

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.