Skip to main content

Get subscription information for the current user

GET 

/users/current/subscription

Get subscription information for the current user

Request

Query Parameters

    _apikey stringrequired

    You can find your API key in the Import.io dashboard under User Settings

Responses

Subscription details retrieved successfully

Schema

    userGuid uuid

    Unique identifier for the user.

    usage integer

    Current usage count for the user.

    maxUsage integer

    Maximum allowed usage count under the plan.

    planCode string

    Code identifying the specific subscription plan.

    autoRenew boolean

    Indicates if the subscription plan is set to auto-renew.

    expiry int64

    Timestamp (in milliseconds since Unix epoch) when the subscription expires.

    overage integer

    Overage usage count not included in the plan.

    numOverageCharges integer

    (For internal use)

    features string[]

    (For internal use) List of features included in the subscription plan.

    qps integer

    (For internal use)

    overageChargeInCents float

    (For internal use)

    overageBlockSize integer

    (For internal use)

    custom boolean

    Indicates if the plan is custom tailored for the user.

    trial boolean

    Indicates if the plan is a trial version.

    provision integer

    (For internal use)

    nextBillingDate int64

    Timestamp (in milliseconds since Unix epoch) for the next billing date.

    nextPlanCode string

    Code of the plan scheduled for after the current plan (if not renewed)

    deactivated boolean

    Indicates if the subscription has been deactivated.

    created int64

    Timestamp (in milliseconds since Unix epoch) when the subscription was created.

    usageStart int64

    Timestamp (in milliseconds since Unix epoch) when usage tracking started.

    basePlanCode string

    (For internal use)

    overageDisabled boolean

    Indicates if customer is not allowed to exceed the query limits (charged separately)

Loading...