> Markdown version of https://docs.paynow.gg/management-api/tier-groups/. The index of all pages is at https://docs.paynow.gg/llms.txt, and any page can be read as Markdown by appending `.md` to its URL.

# Tier Groups

## List all tier groups for a store

```json
{"openapi":"3.1.1","info":{"title":"PayNow Management API","version":"v1"},"tags":[{"name":"tier-groups"}],"security":[{"APIKey":[]}],"components":{"securitySchemes":{"APIKey":{"type":"apiKey","description":"An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.","name":"Authorization","in":"header","x-gitbook-prefix":"APIKey","x-gitbook-token-placeholder":"TOKEN_HERE"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id","example":"411486491630370816"},"TierGroupDto":{"required":["created_at","created_by","id","name","store_id"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"store_id":{"$ref":"#/components/schemas/FlakeId"},"name":{"type":"string","description":"The name of the tier group."},"created_at":{"type":"string","description":"When the tier group was created.","format":"date-time"},"created_by":{"$ref":"#/components/schemas/ActorDto"},"updated_at":{"type":["null","string"],"description":"When was the tier group last updated.","format":"date-time"},"updated_by":{"$ref":"#/components/schemas/ActorDto"}},"additionalProperties":false},"ActorDto":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/PayNowActorType"},"id":{"$ref":"#/components/schemas/FlakeId"}},"additionalProperties":false},"PayNowActorType":{"enum":["anonymous","user","api_key","customer","game_server","internal","admin","platform","global_customer"],"type":"string"},"PayNowError":{"required":["code","message","status"],"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.","format":"int32","example":400},"code":{"type":"string","description":"The PayNow parseable error code.","example":"bad-request"},"message":{"type":"string","description":"The human-readable error message.","example":"Bad Request Example"},"trace_id":{"type":["null","string"],"description":"A distributed trace ID used for debugging.","example":"234a5bcd543ef3fa53ce929d0e0e4736"},"errors":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ValidationError"},"description":"An array of multiple errors. Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/stores/{storeId}/tier-groups":{"get":{"tags":["tier-groups"],"summary":"List all tier groups for a store","operationId":"TierGroups_ListTierGroups","parameters":[{"name":"storeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/TierGroupDto"}}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}},"security":[{"APIKey":[]}]}}}}
```

## Create a new tier group

```json
{"openapi":"3.1.1","info":{"title":"PayNow Management API","version":"v1"},"tags":[{"name":"tier-groups"}],"security":[{"APIKey":[]}],"components":{"securitySchemes":{"APIKey":{"type":"apiKey","description":"An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.","name":"Authorization","in":"header","x-gitbook-prefix":"APIKey","x-gitbook-token-placeholder":"TOKEN_HERE"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id","example":"411486491630370816"},"CreateTierGroupRequestDto":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the tier group."}},"additionalProperties":false},"TierGroupDto":{"required":["created_at","created_by","id","name","store_id"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"store_id":{"$ref":"#/components/schemas/FlakeId"},"name":{"type":"string","description":"The name of the tier group."},"created_at":{"type":"string","description":"When the tier group was created.","format":"date-time"},"created_by":{"$ref":"#/components/schemas/ActorDto"},"updated_at":{"type":["null","string"],"description":"When was the tier group last updated.","format":"date-time"},"updated_by":{"$ref":"#/components/schemas/ActorDto"}},"additionalProperties":false},"ActorDto":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/PayNowActorType"},"id":{"$ref":"#/components/schemas/FlakeId"}},"additionalProperties":false},"PayNowActorType":{"enum":["anonymous","user","api_key","customer","game_server","internal","admin","platform","global_customer"],"type":"string"},"PayNowError":{"required":["code","message","status"],"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.","format":"int32","example":400},"code":{"type":"string","description":"The PayNow parseable error code.","example":"bad-request"},"message":{"type":"string","description":"The human-readable error message.","example":"Bad Request Example"},"trace_id":{"type":["null","string"],"description":"A distributed trace ID used for debugging.","example":"234a5bcd543ef3fa53ce929d0e0e4736"},"errors":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ValidationError"},"description":"An array of multiple errors. Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/stores/{storeId}/tier-groups":{"post":{"tags":["tier-groups"],"summary":"Create a new tier group","operationId":"TierGroups_CreateTierGroup","parameters":[{"name":"storeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTierGroupRequestDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/CreateTierGroupRequestDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/CreateTierGroupRequestDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TierGroupDto"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}},"security":[{"APIKey":[]}]}}}}
```

## Get a tier group by ID

```json
{"openapi":"3.1.1","info":{"title":"PayNow Management API","version":"v1"},"tags":[{"name":"tier-groups"}],"security":[{"APIKey":[]}],"components":{"securitySchemes":{"APIKey":{"type":"apiKey","description":"An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.","name":"Authorization","in":"header","x-gitbook-prefix":"APIKey","x-gitbook-token-placeholder":"TOKEN_HERE"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id","example":"411486491630370816"},"TierGroupDto":{"required":["created_at","created_by","id","name","store_id"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"store_id":{"$ref":"#/components/schemas/FlakeId"},"name":{"type":"string","description":"The name of the tier group."},"created_at":{"type":"string","description":"When the tier group was created.","format":"date-time"},"created_by":{"$ref":"#/components/schemas/ActorDto"},"updated_at":{"type":["null","string"],"description":"When was the tier group last updated.","format":"date-time"},"updated_by":{"$ref":"#/components/schemas/ActorDto"}},"additionalProperties":false},"ActorDto":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/PayNowActorType"},"id":{"$ref":"#/components/schemas/FlakeId"}},"additionalProperties":false},"PayNowActorType":{"enum":["anonymous","user","api_key","customer","game_server","internal","admin","platform","global_customer"],"type":"string"},"PayNowError":{"required":["code","message","status"],"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.","format":"int32","example":400},"code":{"type":"string","description":"The PayNow parseable error code.","example":"bad-request"},"message":{"type":"string","description":"The human-readable error message.","example":"Bad Request Example"},"trace_id":{"type":["null","string"],"description":"A distributed trace ID used for debugging.","example":"234a5bcd543ef3fa53ce929d0e0e4736"},"errors":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ValidationError"},"description":"An array of multiple errors. Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/stores/{storeId}/tier-groups/{tierGroupId}":{"get":{"tags":["tier-groups"],"summary":"Get a tier group by ID","operationId":"TierGroups_GetTierGroup","parameters":[{"name":"storeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"tierGroupId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TierGroupDto"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}},"security":[{"APIKey":[]}]}}}}
```

## Update a tier group by ID

```json
{"openapi":"3.1.1","info":{"title":"PayNow Management API","version":"v1"},"tags":[{"name":"tier-groups"}],"security":[{"APIKey":[]}],"components":{"securitySchemes":{"APIKey":{"type":"apiKey","description":"An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.","name":"Authorization","in":"header","x-gitbook-prefix":"APIKey","x-gitbook-token-placeholder":"TOKEN_HERE"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id","example":"411486491630370816"},"UpdateTierGroupRequestDto":{"required":["name"],"type":"object","properties":{"name":{"type":"string","description":"The name of the tier group."}},"additionalProperties":false},"TierGroupDto":{"required":["created_at","created_by","id","name","store_id"],"type":"object","properties":{"id":{"$ref":"#/components/schemas/FlakeId"},"store_id":{"$ref":"#/components/schemas/FlakeId"},"name":{"type":"string","description":"The name of the tier group."},"created_at":{"type":"string","description":"When the tier group was created.","format":"date-time"},"created_by":{"$ref":"#/components/schemas/ActorDto"},"updated_at":{"type":["null","string"],"description":"When was the tier group last updated.","format":"date-time"},"updated_by":{"$ref":"#/components/schemas/ActorDto"}},"additionalProperties":false},"ActorDto":{"required":["type"],"type":"object","properties":{"type":{"$ref":"#/components/schemas/PayNowActorType"},"id":{"$ref":"#/components/schemas/FlakeId"}},"additionalProperties":false},"PayNowActorType":{"enum":["anonymous","user","api_key","customer","game_server","internal","admin","platform","global_customer"],"type":"string"},"PayNowError":{"required":["code","message","status"],"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.","format":"int32","example":400},"code":{"type":"string","description":"The PayNow parseable error code.","example":"bad-request"},"message":{"type":"string","description":"The human-readable error message.","example":"Bad Request Example"},"trace_id":{"type":["null","string"],"description":"A distributed trace ID used for debugging.","example":"234a5bcd543ef3fa53ce929d0e0e4736"},"errors":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ValidationError"},"description":"An array of multiple errors. Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/stores/{storeId}/tier-groups/{tierGroupId}":{"patch":{"tags":["tier-groups"],"summary":"Update a tier group by ID","operationId":"TierGroups_UpdateTierGroup","parameters":[{"name":"storeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"tierGroupId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTierGroupRequestDto"}},"text/json":{"schema":{"$ref":"#/components/schemas/UpdateTierGroupRequestDto"}},"application/*+json":{"schema":{"$ref":"#/components/schemas/UpdateTierGroupRequestDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TierGroupDto"}}}},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}},"security":[{"APIKey":[]}]}}}}
```

## Delete a tier group by ID

```json
{"openapi":"3.1.1","info":{"title":"PayNow Management API","version":"v1"},"tags":[{"name":"tier-groups"}],"security":[{"APIKey":[]}],"components":{"securitySchemes":{"APIKey":{"type":"apiKey","description":"An API Key token generated in the Dashboard in the format 'APIKey TOKEN_HERE'.","name":"Authorization","in":"header","x-gitbook-prefix":"APIKey","x-gitbook-token-placeholder":"TOKEN_HERE"}},"schemas":{"FlakeId":{"type":"string","additionalProperties":false,"format":"flake-id","example":"411486491630370816"},"PayNowError":{"required":["code","message","status"],"type":"object","properties":{"status":{"type":"integer","description":"The HTTP status code.","format":"int32","example":400},"code":{"type":"string","description":"The PayNow parseable error code.","example":"bad-request"},"message":{"type":"string","description":"The human-readable error message.","example":"Bad Request Example"},"trace_id":{"type":["null","string"],"description":"A distributed trace ID used for debugging.","example":"234a5bcd543ef3fa53ce929d0e0e4736"},"errors":{"type":["null","array"],"items":{"$ref":"#/components/schemas/ValidationError"},"description":"An array of multiple errors. Only used by some API services."}},"additionalProperties":false,"description":"Represents a PayNow error"},"ValidationError":{"required":["code","message","path","validation"],"type":"object","properties":{"code":{"type":"string","description":"The parseable error code."},"message":{"type":"string","description":"The human-readable error message."},"path":{"type":"string","description":"The path leading to the validation error."},"validation":{"type":"string","description":"Type of the validation that failed."}},"additionalProperties":false,"description":"A validation error."}}},"paths":{"/v1/stores/{storeId}/tier-groups/{tierGroupId}":{"delete":{"tags":["tier-groups"],"summary":"Delete a tier group by ID","operationId":"TierGroups_DeleteTierGroup","parameters":[{"name":"storeId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}},{"name":"tierGroupId","in":"path","required":true,"schema":{"$ref":"#/components/schemas/FlakeId"}}],"responses":{"204":{"description":"No Content"},"default":{"description":"Error response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PayNowError"}}}}},"security":[{"APIKey":[]}]}}}}
```