---
title: "Image credits"
method: GET
path: "/social-post-ideas/image-credits"
tags: ["Social Post Ideas"]
---

# Image credits

`GET /social-post-ideas/image-credits`

## Request

- Base URL: `https://api.synup.com/api/v4`
- URL: `https://api.synup.com/api/v4/social-post-ideas/image-credits`
- Auth: none required
- TypeScript: <https://skmtc.dev/synup/apis/synup-api/docs/social-post-ideas/image-credits/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns the image-generation credit status for a brand (social profile) — monthly limit, used/remaining this month, and any add-on credit pool.

## Query parameters

- `socialProfileId` string, required

## Headers

- `Synup-Version` string, required
- `Authorization` string, required

## Response `200`

Successful response

- object
  - `data` object
    - `imageCredits` ImageCredits
      - `socialProfileId` string
      - `monthlyLimit` integer
      - `isActive` boolean
      - `usedThisMonth` integer
      - `remainingThisMonth` integer
      - `addonPurchased` integer
      - `addonConsumed` integer
      - `addonRemaining` integer

## Other responses

- `401`: Unauthorized - Invalid or missing API key

---

[API](https://skmtc.dev/synup/apis/synup-api.md) - [All operations](https://skmtc.dev/synup/apis/synup-api/llms.txt) - [OpenAPI document](https://skmtc.dev/synup/apis/synup-api/revisions/67de2d51c22e?raw)