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

# How many credits are left

> Returns the credit balance, and how many credits running work has reserved. It also returns the monthly bundle, when it resets, and what this period used per kind. Ziplined charges credits per item, once, when the item first shows up for this workspace. An item costs 1 per post, 1 per reaction or comment, and 1 per profile visit or follower. Contact lookups on a sync cost 5 credits per verified email and 25 per phone number.

Use when: Before adding a source or turning on contact lookups, to see what is left.

Do not use for: The whole account with its next step (get_account).



## OpenAPI

````yaml /openapi.json get /v1/credits
openapi: 3.1.0
info:
  title: Ziplined API
  version: 1.0.0
  description: >-
    LinkedIn engagement data about people, companies and posts. The workspace
    comes from the credential; lists page with `limit` and `cursor`.
servers:
  - url: https://api.ziplined.io
    description: Production
security: []
tags:
  - name: People
    description: The people in your workspace, and what you sent them.
  - name: Companies
    description: The companies those people work at.
  - name: Posts
    description: Your own posts and their numbers.
  - name: Engagements
    description: One act by one person on one post.
  - name: Insights
    description: Period against period, and the series behind it.
  - name: Views
    description: The saved views of the app, and who is in a hand-picked one.
  - name: Audiences
    description: The scored target groups, and their membership.
  - name: ICP
    description: 'Who you sell to: the rules every person is scored against.'
  - name: Sources
    description: What your radar collects from.
  - name: Account
    description: Who is asking, what is set up, and what is next.
  - name: Credits
    description: What is left to spend on sources, and when it resets.
  - name: Integrations
    description: 'Where syncs send people: webhook, email, Slack and app destinations.'
paths:
  /v1/credits:
    get:
      tags:
        - Credits
      summary: How many credits are left
      description: >-
        Returns the credit balance, and how many credits running work has
        reserved. It also returns the monthly bundle, when it resets, and what
        this period used per kind. Ziplined charges credits per item, once, when
        the item first shows up for this workspace. An item costs 1 per post, 1
        per reaction or comment, and 1 per profile visit or follower. Contact
        lookups on a sync cost 5 credits per verified email and 25 per phone
        number.


        Use when: Before adding a source or turning on contact lookups, to see
        what is left.


        Do not use for: The whole account with its next step (get_account).
      responses:
        '200':
          description: The result
          content:
            application/json:
              schema:
                type: object
                properties:
                  has_credits:
                    type: boolean
                    description: >-
                      False when this plan does not run on credits. Then every
                      number is null.
                  balance:
                    type: number
                    nullable: true
                    description: >-
                      Credits left right now. It can be negative, because a run
                      that started always runs to its end.
                  reserved:
                    type: number
                    nullable: true
                    description: >-
                      Credits that queued or running work holds. The balance
                      already leaves them out.
                  bundle:
                    type: number
                    nullable: true
                    description: >-
                      The monthly bundle of the plan, or the trial credits while
                      trialing.
                  used_this_period:
                    type: number
                    nullable: true
                  credits_used:
                    type: object
                    nullable: true
                    properties:
                      posts:
                        type: number
                        description: Credits for posts.
                      engagements:
                        type: number
                        description: Credits for reactions and comments.
                      relationships:
                        type: number
                        description: Credits for profile visits and followers.
                      contacts:
                        type: number
                        description: Credits for email and phone lookups.
                    required:
                      - posts
                      - engagements
                      - relationships
                      - contacts
                    description: >-
                      Credits used this period, per kind. Ziplined charges
                      credits per item, once, when the item first shows up for
                      this workspace. An item costs 1 per post, 1 per reaction
                      or comment, and 1 per profile visit or follower. Contact
                      lookups on a sync cost 5 credits per verified email and 25
                      per phone number.
                  leads_this_period:
                    type: number
                    nullable: true
                    description: >-
                      Leads found this period: people who fit and first reacted
                      on or after the first day of the credit period.
                  period_start:
                    type: string
                    nullable: true
                  period_end:
                    type: string
                    nullable: true
                    description: When the bundle resets.
                required:
                  - has_credits
                  - balance
                  - reserved
                  - bundle
                  - used_this_period
                  - credits_used
                  - leads_this_period
                  - period_start
                  - period_end
        '400':
          description: A filter value is invalid, or this resource has no such filter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Wrong workspace, or the credential lacks the required scope.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

````

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