# WhiteLabelGetSubscriptionCredits

Read subscription credits for your White Label site. View=status (default) reports current access, capped by both sponsorship and successful funding. IsActive may be null when billing is ambiguous. Treat only true as confirmed active access. Omit PersonId and StrategyId for the whole site, or supply either filter. Use Limit (1 to 200) and pass NextBeforeSubscriptionId as BeforeSubscriptionId for the next status page. View=history includes grants from all sources and uses NextBeforeGrantId/BeforeGrantId. View=receipt requires the original RequestId and returns zero or one receipt. History and receipt report operations: check Status and ReversedUtc. A receipt alone does not establish current access. An empty receipt does not rule out an in-flight grant committing. After an uncertain grant, retry the identical grant with its original RequestId and QuoteId. A null cursor means there is no further page. Refusals expose the machine-readable reason in ResponseStatus.Errors[].Meta[Reason]. The site comes from your API key.

Endpoint: GET /Strategies/WhiteLabelGetSubscriptionCredits
Version: v4
Security: 

## Query parameters:

  - `View` (string)
    status for current access (default), history for grant records, or receipt for one RequestId

  - `PersonId` (integer,null)
    Optional customer filter. The customer must belong to your White Label site

  - `StrategyId` (integer,null)
    Optional strategy filter

  - `Limit` (integer,null)
    Page size, 1 to 200. Omit to use the server default

  - `BeforeSubscriptionId` (integer,null)
    Status-only cursor from NextBeforeSubscriptionId on the previous page

  - `BeforeGrantId` (integer,null)
    History-only cursor from NextBeforeGrantId on the previous page

  - `RequestId` (string)
    Receipt-only operation ID, preserved without trimming

## Response 200 fields (application/json):

  - `Results` (array,null)
    Result array

  - `Results.WhiteLabelSiteId` (integer,null)
    White Label site bound to the authenticated API key

  - `Results.PersonId` (integer,null)
    Customer PersonId

  - `Results.StrategyId` (integer,null)
    StrategyId

  - `Results.Source` (string,null)
    Upstream grant source. History may include sources other than owned and resold

  - `Results.Payer` (string,null)
    Current payer, when status view supplies it

  - `Results.SubscriptionId` (integer,null)
    Subscription identifier. Null when the upstream identifier is absent or zero

  - `Results.ScheduleId` (integer,null)
    Billing schedule identifier. Null when absent or zero

  - `Results.IsActive` (boolean,null)
    Current access in status view. Only true confirms active access. Null means unknown, including ambiguous billing

  - `Results.IsRecurring` (boolean,null)
    Whether the current subscription recurs. Status view only

  - `Results.IsFiniteSponsorship` (boolean,null)
    Whether current access uses a finite sponsorship. Status view only

  - `Results.SponsorshipEndUtc` (string,null)
    UTC sponsorship boundary. Successful funding is also required for access

  - `Results.FundedThroughUtc` (string,null)
    UTC boundary covered by successful House funding. Advances with successful monthly renewal

  - `Results.EffectiveAccessEndUtc` (string,null)
    Current access boundary in UTC, capped by both successful funding and sponsorship

  - `Results.NextBillingUtc` (string,null)
    Next scheduled billing boundary in UTC

  - `Results.HasFundingProblem` (boolean,null)
    Whether the current sponsorship has a funding problem. Null means not supplied

  - `Results.HasAmbiguousBilling` (boolean,null)
    Whether billing is ambiguous. IsActive may be null and must not be displayed as active

  - `Results.RequestId` (string,null)
    Original site-scoped operation ID. Receipt identity does not establish current access

  - `Results.GrantId` (integer,null)
    Grant receipt identifier

  - `Results.Action` (string,null)
    Upstream operation action, including start_house_subscription, extend_house_sponsorship or already_covered

  - `Results.Status` (string,null)
    Operation status. Check this and ReversedUtc. A receipt lookup alone does not establish current access

  - `Results.PreviousAccessEndUtc` (string,null)
    Access boundary before this operation, in UTC. Null when no prior access exists

  - `Results.AccessEndUtc` (string,null)
    Access boundary recorded for this operation, in UTC. Use status view for current effective access

  - `Results.HouseAccountId` (integer,null)
    House account identifier. Absent for owned strategies

  - `Results.HouseAccountAmount` (number,null)
    Actual House debit for this operation, not the monthly funding total

  - `Results.HouseAccountTransactionId` (integer,null)
    House transaction identifier for this operation. Null when absent or zero

  - `Results.Currency` (string,null)
    Amount currency, USD

  - `Results.CustomerBillingResumes` (boolean,null)
    True when existing customer billing resumes after credits. A resale sponsorship does not automatically convert to customer billing

  - `Results.AppliedUtc` (string,null)
    UTC time the operation was applied

  - `Results.ReversedUtc` (string,null)
    UTC reversal time, when supplied. Check this and Status before interpreting a receipt

  - `Results.IsIdempotentReplay` (boolean,null)
    Grant response only. True means the original receipt was replayed without another grant or debit

  - `ResponseStatus` (object)

  - `ResponseStatus.ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `ResponseStatus.Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `ResponseStatus.Errors` (array,null)

  - `ResponseStatus.Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `ResponseStatus.Errors.FieldName` (string,null)
    The affected parameter.

  - `ResponseStatus.Errors.Message` (string,null)
    More details about the ErrorCode.

  - `WhiteLabelSiteId` (integer,null)
    White Label site bound to the authenticated API key

  - `View` (string,null)
    Returned view: status, history or receipt

  - `NextBeforeSubscriptionId` (integer,null)
    Pass as BeforeSubscriptionId for the next status page. Null means no further page

  - `NextBeforeGrantId` (integer,null)
    Pass as BeforeGrantId for the next history page. Null means no further page

## Response 400 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 401 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 403 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 404 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 406 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 409 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 429 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 500 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.

## Response 503 fields (application/json):

  - `ErrorCode` (string,null)
    The HTTP error code. Please see https://api-docs.collective2.com/guides/error-codes#http-errors.

  - `Message` (string,null)
    The human-readable meaning of the ErrorCode.

  - `Errors` (array,null)

  - `Errors.ErrorCode` (string,null)
    The C2 error code. Please see https://api-docs.collective2.com/guides/error-codes#c2-errors.

  - `Errors.FieldName` (string,null)
    The affected parameter.

  - `Errors.Message` (string,null)
    More details about the ErrorCode.


## Response 304 fields