# WhiteLabelPreviewSubscriptionCredit

Preview subscription-credit eligibility, the proposed access end and House cost for a customer of your White Label site. Provide AddMonths (1 to 24) or AccessThrough (YYYY-MM-DD), not both. Calendar dates include the whole day in America/New_York. Preview charges nothing and grants no access. ImmediateHouseAmount is the debit if applied. HouseMonthlyAmount is the current monthly cost, not a prepaid total or guaranteed future price. Extending an existing API resale sponsorship costs zero immediately and preserves its billing anniversary. Owned strategies have zero House cost. Existing customer billing may resume after credits, as CustomerBillingResumes indicates. The access boundary is proposed. An incremental grant's exact start and end are resolved when applied. QuoteId expires after ten minutes. The site comes from your API key. Non-paginated endpoint.

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

## Query parameters:

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

  - `StrategyId` (integer,null, required)
    StrategyId to preview. Eligibility is checked against your site's catalog

  - `AddMonths` (integer,null)
    Months of access to add, 1 to 24. Supply AddMonths or AccessThrough and omit the unused field

  - `AccessThrough` (string)
    Inclusive access end date, YYYY-MM-DD, in America/New_York. Supply AccessThrough or AddMonths and omit the unused field

## Response 200 fields (application/json):

  - `Results` (array,null)
    Result array

  - `Results.WhiteLabelSiteId` (integer,null)

  - `Results.PersonId` (integer,null)

  - `Results.StrategyId` (integer,null)

  - `Results.Source` (string,null)
    Strategy source: owned or resold

  - `Results.Payer` (string,null)
    Payer: house for resale sponsorship, none for owned strategies, or customer_after_credits when existing customer billing resumes

  - `Results.SubscriptionId` (integer,null)
    Existing subscription identifier. Null when none exists

  - `Results.ScheduleId` (integer,null)
    Existing billing schedule identifier. Null when none exists

  - `Results.PreviousAccessEndUtc` (string,null)
    Previous access boundary in UTC. Null when no prior access exists

  - `Results.AccessEndUtc` (string,null)
    Proposed access boundary in UTC. Exact incremental grant boundaries are resolved when applied

  - `Results.NextChargeUtc` (string,null)
    Next scheduled charge in UTC, when an existing subscription supplies it

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

  - `Results.ImmediateHouseAmount` (number,null)
    House debit if the grant is applied. Preview charges nothing. Zero for an existing API resale sponsorship extension and for owned strategies

  - `Results.HouseMonthlyAmount` (number,null)
    Current monthly House cost. This is neither a prepaid total nor a guaranteed future rate

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

  - `Results.Timezone` (string,null)
    Calendar-date timezone, America/New_York

  - `Results.ChargePolicy` (string,null)
    Charge policy: full_monthly_no_proration for resale sponsorship or no_grant_charge for owned strategies

  - `Results.CustomerBillingResumes` (boolean,null)
    True when existing customer billing resumes after the credits

  - `Results.FuturePriceGuaranteed` (boolean,null)
    Whether the quote guarantees future pricing. Current monthly House cost is not a future rate guarantee

  - `Results.QuoteId` (string,null)
    Quote identifier to use when applying the credit. Valid for ten minutes

  - `Results.QuoteExpiresUtc` (string,null)
    Quote expiry in UTC

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

## 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