> ## Documentation Index > Fetch the complete documentation index at: https://docs.salesbricks.com/llms.txt > Use this file to discover all available pages before exploring further. # List all subscription milestones > Returns the milestones on a subscription's current agreement, with the quantity contracted and the quantity completed so far. ## OpenAPI ````yaml https://api.salesbricks.com/api/v2/openapi.yaml get /subscriptions/{subscription_id}/milestones openapi: 3.0.3 info: title: Salesbricks REST API version: 2.0.0 description: API reference for external integrations servers: - url: https://api.salesbricks.com/api/v2 description: Production - url: https://api.staging.salesbricks.com/api/v2 description: Staging security: - ApiKeyAuth: [] tags: - name: Subscriptions description: >- Operations related to subscription management, including creation, updates, and retrieving subscription details. Subscriptions can be upgraded to add / remove add-ons by using the POST /subscriptions/{subscription_id}/upgrade endpoint and can be recasted for replacing the current agreement using the POST /subscriptions/{subscription_id}/recast endpoint - name: Subscription Milestones description: >- Operations for listing and completing milestone bricks — bricks billed when the work they cover is delivered rather than on the subscription's schedule. Completing one either raises a standalone invoice immediately or bills on the subscription's next scheduled invoice. - name: Customers description: >- Operations related to customer management, including creation, updates, and managing customer person objects. - name: Invoices description: Operations related to subscription's invoicing details. - name: Plans description: >- Operations related to listing and getting plan details including bricks in the plan. - name: Payment Methods description: Operations related to subscription's payment method. paths: /subscriptions/{subscription_id}/milestones: get: tags: - Subscription Milestones summary: List all subscription milestones description: >- Returns the milestones on a subscription's current agreement, with the quantity contracted and the quantity completed so far. operationId: listSubscriptionMilestones parameters: - in: path name: subscription_id schema: type: string pattern: ^([a-zA-Z\d\-]+)$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionMilestoneListOutput' description: '' '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' examples: NotFoundResponse: value: error: code: ERR_NOT_FOUND message: >- Subscription not found — no subscription matches the given `subscription_id`. summary: Not Found Response description: '' components: schemas: SubscriptionMilestoneListOutput: type: object description: Output serializer for the subscription milestones list. properties: milestones: type: array items: $ref: '#/components/schemas/SubscriptionMilestone' description: The subscription's milestones, oldest first. required: - milestones ErrorResponse: type: object description: >- Standardizes API error responses with a consistent structure containing error code and message. properties: error: $ref: '#/components/schemas/Error' required: - error SubscriptionMilestone: type: object description: The state of a single milestone on a subscription. properties: milestone_id: type: string format: uuid description: >- ID of the milestone. Pass this to `POST /subscriptions/{subscription_id}/milestones/{milestone_id}/complete`. brick_id: type: string format: uuid nullable: true description: >- The underlying brick. Not unique across milestones — a multi-phase order carries the same brick in more than one phase. brick_name: type: string description: Name of the brick, or its per-order custom name where set. order_id: type: string format: uuid description: The order in the subscription chain that carries this milestone. phase_position: type: integer description: 0-based position of the order phase carrying this milestone. phase_name: type: string nullable: true description: Name of the order phase carrying this milestone, where it has one. total_quantity: type: integer description: >- The quantity that has to be completed. Included units, and on an upgrade the previously contracted quantity, are already netted off. completed_quantity: type: integer description: >- How much has been completed so far. Completions billed on a voided invoice do not count, so voiding reverts a milestone to incomplete. completions: type: array items: $ref: '#/components/schemas/MilestoneCompletion' description: Every completion recorded against this milestone, oldest first. required: - brick_id - brick_name - completed_quantity - completions - milestone_id - order_id - phase_name - phase_position - total_quantity Error: type: object description: >- Represents individual error details with a standardized code and descriptive message. properties: code: enum: - ERR_NOT_FOUND - ERR_BAD_REQUEST - ERR_SERVER_ERROR type: string x-spec-enum-id: dc5a5d6feae1b697 description: >- Error code indicating the type of error: NOT_FOUND for missing resources, BAD_REQUEST for invalid input, SERVER_ERROR for internal server issues * `ERR_NOT_FOUND` - ERR_NOT_FOUND * `ERR_BAD_REQUEST` - ERR_BAD_REQUEST * `ERR_SERVER_ERROR` - ERR_SERVER_ERROR message: type: string error_id: type: string format: uuid description: >- Correlation handle for SERVER_ERROR responses — quote this when contacting support; it joins to the structured server log line for the failure. Not present on 4xx responses. required: - code - message MilestoneCompletion: type: object description: One recorded completion of a milestone. properties: id: type: string format: uuid description: ID of the completion record. quantity: type: integer description: How much of the milestone this completion billed. invoice_id: type: string format: uuid nullable: true description: >- The invoice this completion is billed on. Null when the invoice was regenerated and the completion is waiting to be reattached. completed_at: type: string format: date-time description: When the milestone was marked complete. required: - completed_at - id - invoice_id - quantity securitySchemes: ApiKeyAuth: type: apiKey in: header name: X-SALESBRICKS-KEY description: API key for authentication ```` ## Related topics - [List all subscription invoices](/api-reference/invoices/list-all-subscription-invoices.md) - [List all subscription orders](/api-reference/subscription-history/list-all-subscription-orders.md) - [List all subscription bricks](/api-reference/subscription-state/list-all-subscription-bricks.md)