> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gomarketbox.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Change package status (rewrites the storefront sort key)

> Moves the bundle between DRAFT, ACTIVE and ARCHIVED. Any status can follow any other — unlike services, there is no transition table, so a bundle can be pulled and reinstated freely. ARCHIVED is the correct way to retire a bundle: it drops out of the storefront and blocks new orders, while credits clients already bought stay bookable, which deleting the offering underneath would not achieve. Status is encoded in the storefront index key and rewritten here in the same write, so a status-filtered list reflects the change immediately rather than lagging.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/projects/{projectId}/packages/{packageId}/status
openapi: 3.0.0
info:
  title: MarketBox 2.0 Open API
  version: 1.0.0
  description: >-
    The MarketBox public API for building booking experiences. Core model:
    create an order, then draw its order items down into bookings. Single
    bookings reference an order item per service line; package bookings draw one
    PACKAGE item down across N sessions. To schedule a package, build a slate
    (POST /availability/package-slate) and book it by slateId (POST
    /orders/{orderId}/package-bookings). See the guides for end-to-end
    walkthroughs.
  contact:
    name: MarketBox support
servers:
  - url: https://apiv2.gomarketbox.com
    description: MarketBox Open API
security:
  - ApiKeyAuth: []
paths:
  /v1/projects/{projectId}/packages/{packageId}/status:
    post:
      tags:
        - ServicePackages
      summary: Change package status (rewrites the storefront sort key)
      description: >-
        Moves the bundle between DRAFT, ACTIVE and ARCHIVED. Any status can
        follow any other — unlike services, there is no transition table, so a
        bundle can be pulled and reinstated freely. ARCHIVED is the correct way
        to retire a bundle: it drops out of the storefront and blocks new
        orders, while credits clients already bought stay bookable, which
        deleting the offering underneath would not achieve. Status is encoded in
        the storefront index key and rewritten here in the same write, so a
        status-filtered list reflects the change immediately rather than
        lagging.
      parameters:
        - schema:
            type: string
            minLength: 1
            description: >-
              The project (tenant) that owns the resource. Every resource in
              this API is scoped to a project, and your API key is restricted to
              the projects it was issued for — a project outside that scope
              returns 403.
            example: prj_01kv60qgnef2kt3pvqgwmkbzfr
          required: true
          description: >-
            The project (tenant) that owns the resource. Every resource in this
            API is scoped to a project, and your API key is restricted to the
            projects it was issued for — a project outside that scope returns
            403.
          name: projectId
          in: path
        - schema:
            type: string
            minLength: 1
            description: >-
              The service package — a bundle of prepaid sessions drawn down by
              bookings.
            example: pkg_01kv7n10k0fnptwk81wkm59vj7
          required: true
          description: >-
            The service package — a bundle of prepaid sessions drawn down by
            bookings.
          name: packageId
          in: path
      requestBody:
        description: New status
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  enum:
                    - DRAFT
                    - ACTIVE
                    - ARCHIVED
                  description: >-
                    Lifecycle of the package bundle. ARCHIVED hides it from the
                    storefront and blocks new orders, but order items already
                    placed against it stay bookable.
              required:
                - status
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ServicePackage'
                required:
                  - data
        '400':
          description: Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '403':
          description: API key cannot access this project
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
components:
  schemas:
    ServicePackage:
      type: object
      properties:
        entityType:
          type: string
          enum:
            - SERVICE_PACKAGE
        projectId:
          type: string
        serviceId:
          type: string
        offeringId:
          type: string
        packageId:
          type: string
        name:
          type: object
          additionalProperties:
            type: string
        description:
          type: object
          additionalProperties:
            type: string
        pricingModel:
          type: string
          enum:
            - PER_SESSION
            - FLAT
        pricing:
          type: array
          items:
            type: object
            properties:
              ruleId:
                type: string
                minLength: 1
              scope:
                type: string
                enum:
                  - DEFAULT
                  - COUNTRY
                  - STATE
                  - POSTAL
                description: >-
                  How specifically a price rule targets a region. Resolution
                  picks the most specific match: POSTAL beats STATE beats
                  COUNTRY beats DEFAULT. DEFAULT is the fallback every offering
                  must define ("any region"). On an order item, `priceScope`
                  reports which one actually applied — seeing DEFAULT where you
                  expected a regional price means the region did not resolve.
              country:
                type: string
                minLength: 1
              state:
                type: string
                minLength: 1
              postalCodes:
                type: array
                items:
                  type: string
                  minLength: 1
              price:
                $ref: '#/components/schemas/Money'
              tax:
                type: object
                properties:
                  taxable:
                    type: boolean
                  taxPercentage:
                    type: number
                    minimum: 0
                required:
                  - taxable
            required:
              - ruleId
              - scope
              - price
          minItems: 1
        creditCount:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        discountPercent:
          type: number
          minimum: 0
          maximum: 100
          description: >-
            Percentage discount (0-100) recorded when this package's prices were
            seeded from the offering's prices (price = offering price *
            creditCount * (1 - discountPercent/100)). Informational metadata
            only: `pricing` is the authoritative source of the amounts charged.
            Individual prices can be manually overridden after seeding, and the
            offering's prices may change later, so this value is not guaranteed
            to match the actual prices - never derive amounts from it.
        validityDays:
          type: integer
          nullable: true
          minimum: 0
          exclusiveMinimum: true
        status:
          type: string
          enum:
            - DRAFT
            - ACTIVE
            - ARCHIVED
          description: >-
            Lifecycle of the package bundle. ARCHIVED hides it from the
            storefront and blocks new orders, but order items already placed
            against it stay bookable.
        capacity:
          type: integer
          minimum: 0
          exclusiveMinimum: true
        deleted:
          type: boolean
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
        createdBy:
          type: string
        updatedBy:
          type: string
      required:
        - entityType
        - projectId
        - serviceId
        - offeringId
        - packageId
        - pricingModel
        - pricing
        - creditCount
        - validityDays
        - status
        - capacity
        - deleted
        - createdAt
        - updatedAt
        - createdBy
        - updatedBy
    ErrorMessage:
      type: object
      properties:
        code:
          type: string
          description: Stable machine-readable error code, e.g. NOT_FOUND.
        message:
          type: string
          description: Human-readable description of what went wrong.
        statusCode:
          type: integer
          description: The HTTP status code of this response.
        requestId:
          type: string
          description: >-
            The id of this request, also returned as the X-Request-Id header.
            Quote it in a support ticket.
      required:
        - code
        - message
        - statusCode
        - requestId
      example:
        code: NOT_FOUND
        message: Booking not found
        statusCode: 404
        requestId: a3f1c2de-9b64-4a2f-8f0e-5c9d1b7a2e10
    Money:
      type: object
      properties:
        amount:
          type: integer
          minimum: 0
        currency:
          type: string
          minLength: 1
          maxLength: 3
      required:
        - amount
        - currency
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key minted in the MarketBox dashboard. Scope is restricted to the
        projects you select at creation time. Every route needs the key's
        standard API access (`*`) except `POST /v1/projects/{projectId}/events`,
        which needs `events:write`; a key without `*` is refused with 403
        `CAPABILITY_NOT_GRANTED`.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.