Skip to content

Billing audit views for marketplace usage submissions and workload charge composition.

GET/billing/subscriptions

List the organization's billing subscriptions

Returns the calling organization's current and historical billing subscriptions across all providers (AWS Marketplace and Stripe). Historical rows support final-period usage navigation and provider-specific resubscribe guidance. Abandoned Stripe checkout reservations are excluded. Provider- agnostic; the per-row provider discriminator distinguishes providers.

Responses

Responses

The organization's current billing subscriptions.

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"id": "A1B2C3D4E5",
  
  
  
"organizationId": "A1B2C3D4E5",
  
  
  
"provider": "AWS",
  
  
  
"providerId": "string",
  
  
  
"providerConfig": {
  
  
  
  
"customerIdentifier": "ABCDEFGH12345",
  
  
  
  
"customerAwsAccountId": "123456789012",
  
  
  
  
"productCode": "abc123def456",
  
  
  
  
"licenseArn": "arn:aws:license-manager::123456789012:license/l-abc123",
  
  
  
  
"agreementId": "agmt-abc123"
  
  
  
},
  
  
  
"status": "pending",
  
  
  
"subscribedAt": "string",
  
  
  
"unsubscribedAt": "string",
  
  
  
"createdAt": "string",
  
  
  
"updatedAt": "string",
  
  
  
"lastSubmissionAt": "string"
  
  
}
  
],
  
"rateCard": {
  
  
"rates": [
  
  
  
{
  
  
  
  
"factor": "string",
  
  
  
  
"currency": "string",
  
  
  
  
"amount": 0
  
  
  
}
  
  
]
  
},
  
"marker": "string"
}
GET/billing/subscriptions/{subscriptionId}/submissions/{submissionId}

Get submission workload composition

Returns workload-level contributions included in a metering submission window, including the physical usage factors used to compute the submitted amount.

Responses

Responses

Workload-level billing composition for one submission.

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"sourceId": "A1B2C3D4E5",
  
  
  
"vcpuHours": 0,
  
  
  
"memoryGbHours": 0,
  
  
  
"dollarAmount": 0,
  
  
  
"vcpuHoursMetered": 0,
  
  
  
"memoryGbHoursMetered": 0,
  
  
  
"workloadLabel": "string"
  
  
}
  
],
  
"rateCard": {
  
  
"rates": [
  
  
  
{
  
  
  
  
"factor": "string",
  
  
  
  
"currency": "string",
  
  
  
  
"amount": 0
  
  
  
}
  
  
]
  
}
}
GET/billing/trial

Get the organization's free-trial status

Returns the calling organization's org-level free-trial status (trials are one per org): whether a trial is active, when it ends, and whether the org already has an entitling subscription. Drives the in-app trial banner, so it is readable by any member.

Responses

Responses

The organization's free-trial status.

application/json
JSON
{
  
"status": "string",
  
"endsAt": "string",
  
"entitled": true,
  
"platform": {
  
  
"availableSubscriptionProviders": [
  
  
  
"AWS"
  
  
],
  
  
"retentionGraceDays": 0,
  
  
"trialUsageVisible": true
  
}
}
GET/billing/usage

Get the organization's usage

Returns the organization's usage for the selected range. When a subscription is selected, usage is returned per collection window and each window says whether it was charged.
Subscription usage includes every customer-meaningful submission outcome. Only accepted outcomes count as billed or trial-covered; every other outcome is explicitly unconfirmed. Trial-covered estimates are returned only where the deployment enables that disclosure. Range totals keep billed, trial-rated, and unconfirmed attempted amounts separate.
Omitting subscription is a narrower trial-only case. It is available only to an organization currently in its trial that has never held a subscription and is not billing-exempt. Because that usage comes from the internal shadow ledger, only the aggregate totals authorized by ADR-082 are returned; items is empty and pagination does not apply.

Parameters

limitinteger
limit

The maximum number of items to list.

Type
integer
Format
"int32"
Minimum
0
Maximum
100
Default
100
markerstring
marker

The pagination token returned from the previous list operation.

Type
string
subscriptionstring
subscription

Limit the usage to one subscription. Omit for the organization's usage that no subscription accounts for, which is what an organization inside a free trial without a subscription has.

Type
string
Example"A1B2C3D4E5"
Min Length
1
Max Length
20
Pattern
"^[A-Z0-9]{1,20}$"
fromstring
from

Include submissions with period_start at or after this timestamp.

Type
string
Format
"date-time"
tostring
to

Include submissions with period_end at or before this timestamp.

Type
string
Format
"date-time"
includeZeroUsageboolean
includeZeroUsage

Include windows where submitted usage quantity was zero.

Type
boolean
Default
false
Responses

Responses

Usage windows for the selected range.

application/json
JSON
{
  
"items": [
  
  
{
  
  
  
"periodStart": "string",
  
  
  
"periodEnd": "string",
  
  
  
"state": "billed",
  
  
  
"amount": 0,
  
  
  
"vcpuHours": 0,
  
  
  
"memoryGbHours": 0,
  
  
  
"submissionId": "A1B2C3D4E5",
  
  
  
"submissionStatus": "accepted",
  
  
  
"billableFrom": "string",
  
  
  
"billableFromReason": "trial_end"
  
  
}
  
],
  
"totals": {
  
  
"billedAmount": 0,
  
  
"trialRatedAmount": 0,
  
  
"unconfirmedAmount": 0,
  
  
"hasTrialUsage": true,
  
  
"vcpuHours": 0,
  
  
"memoryGbHours": 0,
  
  
"windowCount": 0,
  
  
"billedWindowCount": 0,
  
  
"trialWindowCount": 0,
  
  
"unconfirmedWindowCount": 0
  
},
  
"marker": "string"
}

Can't find the answer here? Email us: support@lakesail.com