Preview Plan Change

curl -X GET 'https://app.memorylake.ai/openapi/memorylake/admin/v1/billing/subscription/plan-change-preview?plan_id=9e50b1aed525a8280e28b9662b6a7ba0' \
  -H 'Authorization: Bearer sk_xxxxxx'

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "applicable": false,
    "lines": [
      {
        "amount": {
          "amount": 1999,
          "currency": "usd"
        },
        "description": "Example description",
        "proration": false,
        "period_end": 1760000000,
        "period_start": 1760000000
      }
    ],
    "plan_id": 1,
    "amount_due": {
      "amount": 1999,
      "currency": "usd"
    },
    "effective_at": 1760000000,
    "from_plan": {
      "id": 1,
      "name": "Example name"
    },
    "next_invoice": {
      "amount": {
        "amount": 1999,
        "currency": "usd"
      },
      "date": 1
    },
    "proration_date": 1,
    "reason": "no_paid_subscription",
    "to_plan": {
      "id": 1,
      "name": "Example name"
    }
  }
}

curl -X GET 'https://app.memorylake.ai/openapi/memorylake/admin/v1/billing/subscription/plan-change-preview?plan_id=9e50b1aed525a8280e28b9662b6a7ba0' \
  -H 'Authorization: Bearer sk_xxxxxx'

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "applicable": false,
    "lines": [
      {
        "amount": {
          "amount": 1999,
          "currency": "usd"
        },
        "description": "Example description",
        "proration": false,
        "period_end": 1760000000,
        "period_start": 1760000000
      }
    ],
    "plan_id": 1,
    "amount_due": {
      "amount": 1999,
      "currency": "usd"
    },
    "effective_at": 1760000000,
    "from_plan": {
      "id": 1,
      "name": "Example name"
    },
    "next_invoice": {
      "amount": {
        "amount": 1999,
        "currency": "usd"
      },
      "date": 1
    },
    "proration_date": 1,
    "reason": "no_paid_subscription",
    "to_plan": {
      "id": 1,
      "name": "Example name"
    }
  }
}

GET /openapi/memorylake/admin/v1/billing/subscription/plan-change-preview

Prices switching the subscription to plan_id without changing anything: the prorated amount charged now, its line items, when the change takes effect and the next full invoice. proration_date echoes the instant the proration was computed for. Switches that cost nothing come back with applicable false and a reason. Changing the plan itself is done in the console.

Permission required: subscription:manage

Query Parameters

integer

required

The plan to price a switch to

curl -X GET 'https://app.memorylake.ai/openapi/memorylake/admin/v1/billing/subscription/plan-change-preview?plan_id=9e50b1aed525a8280e28b9662b6a7ba0' \
  -H 'Authorization: Bearer sk_xxxxxx'

Response

object

Show Plan Change Preview object

boolean

false = nothing to price: see reason. The change itself may still be valid.

array

Line items behind amount_due; empty when not applicable

Show Plan Change Preview Line object

object

Line amount; negative for credit for unused time

Show Money object

integer

Amount in the currency’s smallest unit (cents for usd)

string

Lowercase ISO 4217 currency code

string

Line description

boolean

true for a prorated line

integer

Service period end, Unix seconds

integer

Service period start, Unix seconds

integer

The target plan, as requested

object

Charged immediately if the change were made now (prorated); negative = credit to the balance. Present when applicable.

Show Money object

integer

Amount in the currency’s smallest unit (cents for usd)

string

Lowercase ISO 4217 currency code

integer

When the change would take effect, Unix seconds: now for an upgrade, the period end for a downgrade to free

object

The current plan

Show Plan Ref object

integer

Plan id

string

Plan name

object

The first full-cycle invoice on the new plan. Present when applicable.

Show Next Invoice object

object

Full price of the new plan for one cycle

Show Money object

integer

Amount in the currency’s smallest unit (cents for usd)

string

Lowercase ISO 4217 currency code

integer

When it is issued, Unix seconds

integer

The instant the proration was computed for, Unix seconds. Present when applicable.

string

Why there is nothing to price: no_paid_subscription (the current subscription is not paid through the payment provider), downgrade_to_free (moving to the free plan takes effect at period end, no charge), resume_only (target is the current plan of a subscription set to cancel: switching back only resumes it)

object

The target plan

Show Plan Ref object

integer

Plan id

string

Plan name

{
  "success": true,
  "message": "Operation completed successfully",
  "data": {
    "applicable": false,
    "lines": [
      {
        "amount": {
          "amount": 1999,
          "currency": "usd"
        },
        "description": "Example description",
        "proration": false,
        "period_end": 1760000000,
        "period_start": 1760000000
      }
    ],
    "plan_id": 1,
    "amount_due": {
      "amount": 1999,
      "currency": "usd"
    },
    "effective_at": 1760000000,
    "from_plan": {
      "id": 1,
      "name": "Example name"
    },
    "next_invoice": {
      "amount": {
        "amount": 1999,
        "currency": "usd"
      },
      "date": 1
    },
    "proration_date": 1,
    "reason": "no_paid_subscription",
    "to_plan": {
      "id": 1,
      "name": "Example name"
    }
  }
}

Errors

Errors answer with success: false, a message and an error_code. See Error Codes for every code.

Status	Meaning
`400`	A parameter or the body is invalid
`401`	The API key is missing, invalid, disabled or expired
`403`	The key is not allowed to do this
`409`	The request conflicts with the current state, e.g. a duplicate or a limit reached
`422`	The body or a parameter failed validation
`429`	Too many requests. Wait for the time in `Retry-After`
`500`	Server-side error
`503`	Temporarily unavailable. Retry later

MemoryLake API

Memory Router API

Query Parameters

Response

Errors

​Query Parameters

​Response

​Errors

Query Parameters

Response

Errors