Grant credits to company

POST

https://api.schematichq.com/billing/credits/grants/company

POST

/billing/credits/grants/company

1 import { SchematicClient } from "@schematichq/schematic-typescript-node";
2 
3 async function main() {
4     const client = new SchematicClient({
5         apiKey: "YOUR_API_KEY_HERE",
6     });
7     await client.credits.grantBillingCreditsToCompany({
8         companyId: "c1234567-89ab-4def-0123-456789abcdef",
9         creditId: "cr9876543-21fe-4dcb-9876-54321fedcba0",
10         quantity: 50,
11         reason: "adjustment",
12     });
13 }
14 main();

1 {
2   "data": {
3     "company_id": "c1234567-89ab-4def-0123-456789abcdef",
4     "company_name": "Acme Corporation",
5     "created_at": "2024-01-15T09:30:00Z",
6     "credit_id": "cr9876543-21fe-4dcb-9876-54321fedcba0",
7     "credit_name": "Standard Usage Credit",
8     "grant_reason": "adjustment",
9     "id": "g1234567-89ab-4def-0123-456789abcdef",
10     "quantity": 50,
11     "quantity_remaining": 45.5,
12     "quantity_used": 4.5,
13     "renewal_enabled": true,
14     "source_label": "Initial Grant",
15     "updated_at": "2024-01-20T10:00:00Z",
16     "credit_icon": "https://cdn.schematichq.com/icons/credit-adjustment.png",
17     "currency": "USD",
18     "expires_at": "2024-07-15T09:30:00Z",
19     "plan_id": "p1234567-89ab-4def-0123-456789abcdef",
20     "plan_name": "Pro Plan",
21     "price": {
22       "currency": "USD",
23       "external_price_id": "price_1Hh1YZ2eZvKYlo2C0a1b2c3d",
24       "id": "price_1Hh1YZ2eZvKYlo2C0a1b2c3d",
25       "interval": "month",
26       "interval_count": 1,
27       "price": 4999,
28       "provider_type": "stripe",
29       "scheme": "per_unit",
30       "nickname": "Monthly Pro Plan Price",
31       "price_decimal": "49.99"
32     },
33     "renewal_period": "monthly",
34     "reserved": 0,
35     "settled": 4.5,
36     "source_grant_id": "g7654321-ba98-fedc-3210-abcdef987654",
37     "transfers": [
38       {
39         "amount": 10,
40         "created_at": "2024-01-15T09:30:00Z",
41         "direction": "inbound",
42         "id": "t1234567-89ab-4def-0123-456789abcdef",
43         "reason": "manual adjustment",
44         "related_grant_id": "g1234567-89ab-4def-0123-456789abcdef"
45       }
46     ],
47     "valid_from": "2024-01-15T09:30:00Z",
48     "zeroed_out_date": "2024-07-15T09:30:00Z",
49     "zeroed_out_reason": "expired"
50   },
51   "params": {}
52 }

Authentication

X-Schematic-Api-Keystring

API Key authentication via header

Request

This endpoint expects an object.

company_idstringRequired

credit_idstringRequired

quantitylongRequired>=1

reasonenumRequired

billing_periods_countlong or nullOptional>=1

currencystring or nullOptional<=3 characters

expires_atdatetime or nullOptional

expiry_typeenum or nullOptional

expiry_unitenum or nullOptional

expiry_unit_countlong or nullOptional>=1

renewal_enabledboolean or nullOptional

renewal_periodenum or nullOptional

Response

Created

dataobject

paramsobject

Input parameters

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error