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).

GET

credits

How many credits are left

curl --request GET \
  --url https://api.ziplined.io/v1/credits \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ziplined.io/v1/credits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ziplined.io/v1/credits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ziplined.io/v1/credits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ziplined.io/v1/credits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "has_credits": true,
  "balance": 123,
  "reserved": 123,
  "bundle": 123,
  "used_this_period": 123,
  "credits_used": {
    "posts": 123,
    "engagements": 123,
    "relationships": 123,
    "contacts": 123
  },
  "leads_this_period": 123,
  "period_start": "<string>",
  "period_end": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

The result

has_credits

boolean

required

False when this plan does not run on credits. Then every number is null.

balance

number | null

required

Credits left right now. It can be negative, because a run that started always runs to its end.

reserved

number | null

required

Credits that queued or running work holds. The balance already leaves them out.

bundle

number | null

required

The monthly bundle of the plan, or the trial credits while trialing.

used_this_period

number | null

required

credits_used

object | null

required

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.

Show child attributes

leads_this_period

number | null

required

Leads found this period: people who fit and first reacted on or after the first day of the credit period.

period_start

string | null

required

period_end

string | null

required

When the bundle resets.

How many credits are left

curl --request GET \
  --url https://api.ziplined.io/v1/credits \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ziplined.io/v1/credits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.ziplined.io/v1/credits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.ziplined.io/v1/credits"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ziplined.io/v1/credits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "has_credits": true,
  "balance": 123,
  "reserved": 123,
  "bundle": 123,
  "used_this_period": 123,
  "credits_used": {
    "posts": 123,
    "engagements": 123,
    "relationships": 123,
    "contacts": 123
  },
  "leads_this_period": 123,
  "period_start": "<string>",
  "period_end": "<string>"
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>"
  }
}

People

Companies

Posts

Engagements

Insights

Views

Audiences

ICP

Sources

Account

Credits

Integrations

How many credits are left

Authorizations

Response