{"id":"1217e5b7-5fbd-4d6d-9aa5-5cf4a7375fcb","createdDate":"2024-05-09T08:15:41.056Z","updatedDate":"2024-05-09T08:15:41.056Z","resourceId":"fd9ad542-b05b-4eac-9043-46d31b971de9","api":{"schema":{"object":{"displayName":"Program Object","description":"A loyalty program allows sites to maintain customer reward accounts. Site owners can create a\nloyalty program to increase customer retention. Read more about the loyalty program in\n[this overview](https://support.wix.com/en/article/wix-loyalty-program-an-overview).","slug":"program-object","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","legacyExamples":[{"title":"LoyaltyProgram","content":"{\n \"loyaltyProgram\": {\n \"name\": \"Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Stars\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/58819f398c36404f8017aa8faa2240b4.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"DISABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-06-07T08:40:47.426Z\"\n }\n}"}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"methods":[{"summary":"Get Loyalty Program","description":"Retrieves the loyalty program.","operationId":"com.wixpress.loyalty.program.LoyaltyPrograms.GetLoyaltyProgram","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.program.GetLoyaltyProgramResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-programs","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-programs","destinationPath":"","url":"www.wixapis.com"}}],"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_PROGRAM"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-programs","serviceArtifactId":"com.wixpress.loyalty.loyalty-programs","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.program.GetLoyaltyProgramRequest","responseMessage":"com.wixpress.loyalty.program.GetLoyaltyProgramResponse"},"legacyExamples":[{"name":"GetLoyaltyProgram","type":"METHOD","content":{"title":"Get loyalty program","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-programs/v1/program' \\\n -H 'Authorization: '","response":"{\n \"loyaltyProgram\": {\n \"name\": \"Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Stars\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"DISABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-05-25T10:36:32.430Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"get","path":"/v1/program","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.READ_PROGRAM"],"externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-programs","serviceArtifactId":"com.wixpress.loyalty.loyalty-programs","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.program.GetLoyaltyProgramRequest","responseMessage":"com.wixpress.loyalty.program.GetLoyaltyProgramResponse"},"legacyExamples":[{"name":"GetLoyaltyProgram","type":"METHOD","content":{"title":"Get loyalty program","request":"curl -X GET \\\n 'https://www.wixapis.com/loyalty-programs/v1/program' \\\n -H 'Authorization: '","response":"{\n \"loyaltyProgram\": {\n \"name\": \"Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Stars\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"DISABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-05-25T10:36:32.430Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Get Loyalty Program","slugifiedName":"get-loyalty-program"}},{"summary":"Update Loyalty Program","description":"Updates the loyalty program.\n\nYou cannot activate the loyalty program using this endpoint. To do so, use the [Activate Loyalty Program endpoint](https://dev.wix.com/api/rest/wix-loyalty-program/program/activate-loyalty-program).","operationId":"com.wixpress.loyalty.program.LoyaltyPrograms.UpdateLoyaltyProgram","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.program.UpdateLoyaltyProgramResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-programs","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-programs","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"UpdateLoyaltyProgramRequest","description":"","properties":{"loyaltyProgram":{"description":"Loyalty program fields to update.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"deprecated":false,"required":["loyaltyProgram"]}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Program Updated","description":"Triggered when a loyalty program is updated.","permissions":["LOYALTY.READ_PROGRAM"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.program","serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.program_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_PROGRAM"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-programs","serviceArtifactId":"com.wixpress.loyalty.loyalty-programs","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.program.UpdateLoyaltyProgramRequest","responseMessage":"com.wixpress.loyalty.program.UpdateLoyaltyProgramResponse"},"legacyExamples":[{"name":"UpdateLoyaltyProgram","type":"METHOD","content":{"title":"Update loyalty program","request":"curl -X PATCH \\\n 'https://www.wixapis.com/loyalty-programs/v1/program' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"loyaltyProgram\": {\n \"name\": \"Northern Star Loyalty Program\",\n \"points\": {\n \"customName\": \"Northern Star\"\n }\n }\n }'","response":"{\n \"loyaltyProgram\": {\n \"name\": \"Northern Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Northern Star\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"DISABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-06-07T08:40:47.426Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"patch","path":"/v1/program","rpcOnly":false,"triggeredEvents":[{"title":"Program Updated","description":"Triggered when a loyalty program is updated.","permissions":["LOYALTY.READ_PROGRAM"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.program","serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.program_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_PROGRAM"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-programs","serviceArtifactId":"com.wixpress.loyalty.loyalty-programs","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.program.UpdateLoyaltyProgramRequest","responseMessage":"com.wixpress.loyalty.program.UpdateLoyaltyProgramResponse"},"legacyExamples":[{"name":"UpdateLoyaltyProgram","type":"METHOD","content":{"title":"Update loyalty program","request":"curl -X PATCH \\\n 'https://www.wixapis.com/loyalty-programs/v1/program' \\\n -H 'Authorization: ' \\\n -H 'Content-Type: application/json' \\\n --data-raw '{\n \"loyaltyProgram\": {\n \"name\": \"Northern Star Loyalty Program\",\n \"points\": {\n \"customName\": \"Northern Star\"\n }\n }\n }'","response":"{\n \"loyaltyProgram\": {\n \"name\": \"Northern Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Northern Star\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"DISABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-06-07T08:40:47.426Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Update Loyalty Program","slugifiedName":"update-loyalty-program"}},{"summary":"Activate Loyalty Program","description":"Activates a loyalty program.\n\nWhen a loyalty program is installed it starts in `DRAFT` status. Customers cannot earn or redeem points while the program is not `ACTIVE`.","operationId":"com.wixpress.loyalty.program.LoyaltyPrograms.ActivateLoyaltyProgram","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.program.ActivateLoyaltyProgramResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-programs","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-programs","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"ActivateLoyaltyProgramRequest","description":"","properties":{},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Program Updated","description":"Triggered when a loyalty program is updated.","permissions":["LOYALTY.READ_PROGRAM"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.program","serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.program_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_PROGRAM"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-programs","serviceArtifactId":"com.wixpress.loyalty.loyalty-programs","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.program.ActivateLoyaltyProgramRequest","responseMessage":"com.wixpress.loyalty.program.ActivateLoyaltyProgramResponse"},"legacyExamples":[{"name":"ActivateLoyaltyProgram","type":"METHOD","content":{"title":"Activate loyalty program","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-programs/v1/program/activate' \\\n -H 'Authorization: '","response":"{\n \"loyaltyProgram\": {\n \"name\": \"Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Stars\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"DISABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-05-25T10:36:32.430Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/program/activate","rpcOnly":false,"triggeredEvents":[{"title":"Program Updated","description":"Triggered when a loyalty program is updated.","permissions":["LOYALTY.READ_PROGRAM"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.program","serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.program_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_PROGRAM"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-programs","serviceArtifactId":"com.wixpress.loyalty.loyalty-programs","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.program.ActivateLoyaltyProgramRequest","responseMessage":"com.wixpress.loyalty.program.ActivateLoyaltyProgramResponse"},"legacyExamples":[{"name":"ActivateLoyaltyProgram","type":"METHOD","content":{"title":"Activate loyalty program","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-programs/v1/program/activate' \\\n -H 'Authorization: '","response":"{\n \"loyaltyProgram\": {\n \"name\": \"Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Stars\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"DISABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-05-25T10:36:32.430Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Activate Loyalty Program","slugifiedName":"activate-loyalty-program"}},{"summary":"Pause Loyalty Program","description":"Changes the program status to `PAUSED`.","operationId":"com.wixpress.loyalty.program.LoyaltyPrograms.PauseLoyaltyProgram","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.program.PauseLoyaltyProgramResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-programs","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-programs","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"PauseLoyaltyProgramRequest","description":"","properties":{},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_PROGRAM"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-programs","serviceArtifactId":"com.wixpress.loyalty.loyalty-programs","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.program.PauseLoyaltyProgramRequest","responseMessage":"com.wixpress.loyalty.program.PauseLoyaltyProgramResponse"},"legacyExamples":[{"name":"PauseLoyaltyProgram","type":"METHOD","content":{"title":"Pause loyalty program","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-programs/v1/program/pause' \\\n -H 'Authorization: '","response":"{\n \"loyaltyProgram\": {\n \"name\": \"Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Stars\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"DISABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-05-25T10:36:32.430Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/program/pause","rpcOnly":false,"triggeredEvents":[],"serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_PROGRAM"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-programs","serviceArtifactId":"com.wixpress.loyalty.loyalty-programs","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.program.PauseLoyaltyProgramRequest","responseMessage":"com.wixpress.loyalty.program.PauseLoyaltyProgramResponse"},"legacyExamples":[{"name":"PauseLoyaltyProgram","type":"METHOD","content":{"title":"Pause loyalty program","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-programs/v1/program/pause' \\\n -H 'Authorization: '","response":"{\n \"loyaltyProgram\": {\n \"name\": \"Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Stars\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"DISABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-05-25T10:36:32.430Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Pause Loyalty Program","slugifiedName":"pause-loyalty-program"}},{"summary":"Enable Points Expiration","description":"Updates the `pointsExpiration` status to `ENABLED`.","operationId":"com.wixpress.loyalty.program.LoyaltyPrograms.EnablePointsExpiration","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.program.EnablePointsExpirationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-programs","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-programs","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"EnablePointsExpirationRequest","description":"","properties":{},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Program Updated","description":"Triggered when a loyalty program is updated.","permissions":["LOYALTY.READ_PROGRAM"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.program","serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.program_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_PROGRAM"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-programs","serviceArtifactId":"com.wixpress.loyalty.loyalty-programs","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.program.EnablePointsExpirationRequest","responseMessage":"com.wixpress.loyalty.program.EnablePointsExpirationResponse"},"legacyExamples":[{"name":"EnablePointsExpiration","type":"METHOD","content":{"title":"Enable points expiration","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-programs/v1/program/points-expiration/enable' \\\n -H 'Authorization: '","response":"{\n \"loyaltyProgram\": {\n \"name\": \"Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Stars\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"ENABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-05-25T10:36:32.430Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/program/points-expiration/enable","rpcOnly":false,"triggeredEvents":[{"title":"Program Updated","description":"Triggered when a loyalty program is updated.","permissions":["LOYALTY.READ_PROGRAM"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.program","serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.program_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_PROGRAM"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-programs","serviceArtifactId":"com.wixpress.loyalty.loyalty-programs","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.program.EnablePointsExpirationRequest","responseMessage":"com.wixpress.loyalty.program.EnablePointsExpirationResponse"},"legacyExamples":[{"name":"EnablePointsExpiration","type":"METHOD","content":{"title":"Enable points expiration","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-programs/v1/program/points-expiration/enable' \\\n -H 'Authorization: '","response":"{\n \"loyaltyProgram\": {\n \"name\": \"Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Stars\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"ENABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-05-25T10:36:32.430Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Enable Points Expiration","slugifiedName":"enable-points-expiration"}},{"summary":"Disable Points Expiration","description":"Updates the `pointsExpiration` status to `DISABLED`.","operationId":"com.wixpress.loyalty.program.LoyaltyPrograms.DisablePointsExpiration","parameters":[],"responses":{"200":{"$ref":"#/components/schemas/com.wixpress.loyalty.program.DisablePointsExpirationResponse","description":""}},"deprecated":false,"servers":[{"url":"https://www.wixapis.com/loyalty-programs","x-wix-docs":{"mappingType":"UNKNOWN_MAPPING","sourcePath":"/loyalty-programs","destinationPath":"","url":"www.wixapis.com"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","title":"DisablePointsExpirationRequest","description":"","properties":{},"deprecated":false}}}},"x-wix-docs":{"triggeredEvents":[{"title":"Program Updated","description":"Triggered when a loyalty program is updated.","permissions":["LOYALTY.READ_PROGRAM"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.program","serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.program_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_PROGRAM"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-programs","serviceArtifactId":"com.wixpress.loyalty.loyalty-programs","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.program.DisablePointsExpirationRequest","responseMessage":"com.wixpress.loyalty.program.DisablePointsExpirationResponse"},"legacyExamples":[{"name":"DisablePointsExpiration","type":"METHOD","content":{"title":"Enable points expiration","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-programs/v1/program/points-expiration/disable' \\\n -H 'Authorization: '","response":"{\n \"loyaltyProgram\": {\n \"name\": \"Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Stars\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"DISABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-05-25T10:36:32.430Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git"},"httpMethod":"post","path":"/v1/program/points-expiration/disable","rpcOnly":false,"triggeredEvents":[{"title":"Program Updated","description":"Triggered when a loyalty program is updated.","permissions":["LOYALTY.READ_PROGRAM"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.program","serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","domainEvent":"UPDATED","externalPermissionScopes":[],"eventType":"wix.loyalty.v1.program_updated","sourceRepo":"git@github.com:wix-private/app-market.git"}],"serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","errors":[],"exposure":"PUBLIC","maturity":"GA","permissions":["LOYALTY.MANAGE_PROGRAM"],"externalPermissionScopes":[{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"protoArtifactId":"com.wixpress.loyalty:loyalty-programs","serviceArtifactId":"com.wixpress.loyalty.loyalty-programs","labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}],"rpcMethodDetails":{"requestMessage":"com.wixpress.loyalty.program.DisablePointsExpirationRequest","responseMessage":"com.wixpress.loyalty.program.DisablePointsExpirationResponse"},"legacyExamples":[{"name":"DisablePointsExpiration","type":"METHOD","content":{"title":"Enable points expiration","request":"curl -X POST \\\n 'https://www.wixapis.com/loyalty-programs/v1/program/points-expiration/disable' \\\n -H 'Authorization: '","response":"{\n \"loyaltyProgram\": {\n \"name\": \"Star Loyalty Program\",\n \"pointDefinition\": {\n \"customName\": \"Stars\",\n \"icon\": {\n \"id\": \"\",\n \"url\": \"shapes/39dce0a5d1ce498f95526b1390eaf585.svg\",\n \"height\": 0,\n \"width\": 0\n }\n },\n \"status\": \"ACTIVE\",\n \"pointsExpiration\": {\n \"status\": \"DISABLED\",\n \"monthsOfInactivity\": 3,\n \"expiringPointsPercentage\": 100\n },\n \"premiumFeatures\": {\n \"loyaltyProgram\": true,\n \"tiers\": true,\n \"pointsExpiration\": true\n },\n \"createdDate\": \"2022-05-22T08:18:32.186Z\",\n \"updatedDate\": \"2022-05-25T10:36:32.430Z\"\n }\n}"}}],"sourceRepo":"git@github.com:wix-private/app-market.git","contentLink":{"displayName":"Disable Points Expiration","slugifiedName":"disable-points-expiration"}}],"webhooks":[{"summary":"Loyalty Program Updated","title":"Program Updated","description":"Triggered when a loyalty program is updated.","permissions":["LOYALTY.READ_PROGRAM"],"exposure":"PUBLIC","maturity":"GA","slug":"updated","eventTopic":"domain_events_wix.loyalty.v1.program","serviceName":"com.wixpress.loyalty.program.LoyaltyPrograms","domainEvent":"UPDATED","externalPermissionScopes":[{"name":"Read Loyalty","scopeId":"SCOPE.DC-LOYALTY.READ-LOYALTY"},{"name":"Manage Loyalty","scopeId":"SCOPE.DC-LOYALTY.MANAGE-LOYALTY"}],"eventType":"wix.loyalty.v1.program_updated","legacyExamples":[],"sourceRepo":"git@github.com:wix-private/app-market.git","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","contentLink":{"displayName":"Loyalty Program Updated","slugifiedName":"loyalty-program-updated"},"labels":[{"identifier":"GA"},{"identifier":"exposure","values":["PUBLIC"]}]}],"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Loyalty Program\n\nThe loyalty program API allows a site owner to activate their site's loyalty program and manage its details, like the point name and point icon. The loyalty program must be `ACTIVE` to start creating customer loyalty accounts and tracking their point balances.\n\nWith the loyalty program API, you can:\n+ Activate a loyalty program.\n+ Update the name and icon for the program's points.\n+ Retrieve a loyalty program.\n\n> **Note:**\n> In order to use the loyalty program API, the Wix site owner must first install the Wix Loyalty Program app to their site. A site owner can install the app through their [dashboard](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or the [Wix App Market](fallback::https://www.wix.com/app-market/loyalty).","sourceRepo":"git@github.com:wix-private/app-market.git","path":"proto/docs/introduction.md"}],"components":{"schemas":{"com.wixpress.loyalty.program.LoyaltyProgram":{"type":"object","properties":{"name":{"description":"Program name.","minLength":2,"maxLength":50,"title":"name","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pointDefinition":{"description":"Details about the program's collectible unit.","$ref":"#/components/schemas/com.wixpress.loyalty.program.PointDefinition","summary":"pointDefinition","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"status":{"description":"Program status. Customers can only earn or redeem points while the program is `ACTIVE`.\n\nDefault: `\"DRAFT\"`","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.loyalty.program.ProgramStatusEnum.ProgramStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdDate":{"description":"Date and time the program was created.","readOnly":true,"title":"createdDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time the program was updated.","readOnly":true,"title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pointsExpiration":{"description":"Points expiration configuration","$ref":"#/components/schemas/com.wixpress.loyalty.program.PointsExpiration","summary":"pointsExpiration","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"premiumFeatures":{"description":"Information about available premium features","readOnly":true,"$ref":"#/components/schemas/com.wixpress.loyalty.program.PremiumFeatures","summary":"premiumFeatures","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LoyaltyProgram","description":"A loyalty program allows sites to maintain customer reward accounts. Site owners can create a\nloyalty program to increase customer retention. Read more about the loyalty program in\n[this overview](https://support.wix.com/en/article/wix-loyalty-program-an-overview)."},"google.protobuf.StringValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"StringValue","description":""},"com.wixpress.loyalty.program.PointDefinition":{"type":"object","properties":{"customName":{"description":"Display name for the program's collectible unit.\n\nIt's recommended to use a plural, for example `Stars`.\n\nIn contrast to a custom name, the default `\"Points\"` name is translated and adjusted to singular based on circumstances.\n\nDefault: `Points`.\n\nMax: `20` characters.","maxLength":20,"title":"customName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"icon":{"description":"Details about the points icon.","$ref":"#/components/schemas/wix.common.Image","summary":"icon","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PointDefinition","description":""},"wix.common.Image":{"type":"object","properties":{"id":{"description":"WixMedia image ID.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"url":{"description":"Image URL.","title":"url","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"height":{"description":"Original image height.","readOnly":true,"title":"height","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"width":{"description":"Original image width.","readOnly":true,"title":"width","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"altText":{"description":"Image alt text.","title":"altText","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"filename":{"description":"Image filename.","readOnly":true,"title":"filename","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Image","description":""},"google.protobuf.Timestamp":{"type":"object","properties":{"seconds":{"description":"","title":"seconds","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"nanos":{"description":"","title":"nanos","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Timestamp","description":""},"com.wixpress.loyalty.program.ProgramStatusEnum.ProgramStatus":{"type":"string","description":"","title":"ProgramStatus","enum":["UNKNOWN","DRAFT","ACTIVE","PAUSED"]},"com.wixpress.loyalty.program.PointsExpiration":{"type":"object","properties":{"status":{"description":"Status of points expiration feature","readOnly":true,"title":"status","type":"string","$ref":"#/components/schemas/com.wixpress.loyalty.program.PointsExpiration.Status","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"monthsOfInactivity":{"description":"Expire points after set months of inactivity","minimum":1,"maximum":12,"title":"monthsOfInactivity","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expiringPointsPercentage":{"description":"Percentage of points expiring","minimum":1,"maximum":100,"title":"expiringPointsPercentage","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PointsExpiration","description":""},"com.wixpress.loyalty.program.PointsExpiration.Status":{"type":"string","description":"","title":"Status","enum":["UNKNOWN_STATUS","DISABLED","ENABLED"]},"com.wixpress.loyalty.program.PremiumFeatures":{"type":"object","properties":{"loyaltyProgram":{"description":"Set to true if user has loyalty program premium feature","readOnly":true,"title":"loyaltyProgram","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tiers":{"description":"Set to true if user has tiers premium feature","readOnly":true,"title":"tiers","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pointsExpiration":{"description":"Set to true if user has points expiration premium feature","readOnly":true,"title":"pointsExpiration","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PremiumFeatures","description":""},"com.wixpress.loyalty.program.GetLoyaltyProgramRequest":{"type":"object","properties":{},"title":"GetLoyaltyProgramRequest","description":""},"com.wixpress.loyalty.program.GetLoyaltyProgramResponse":{"type":"object","properties":{"loyaltyProgram":{"description":"Retrieved loyalty program.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetLoyaltyProgramResponse","description":""},"com.wixpress.loyalty.program.BulkGetLoyaltyProgramRequest":{"type":"object","properties":{"metaSiteIds":{"description":"Metasite IDs.","format":"GUID","maxItems":50,"title":"metaSiteIds","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkGetLoyaltyProgramRequest","description":""},"com.wixpress.loyalty.program.BulkGetLoyaltyProgramResponse":{"type":"object","properties":{"programInSites":{"description":"Retrieved loyalty programs.","title":"programInSites","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.loyalty.program.ProgramInSite"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BulkGetLoyaltyProgramResponse","description":""},"com.wixpress.loyalty.program.ProgramInSite":{"type":"object","properties":{"metaSiteId":{"description":"Metasite ID.","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"loyaltyProgram":{"description":"Loyalty program.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ProgramInSite","description":""},"com.wixpress.loyalty.program.UpdateLoyaltyProgramRequest":{"type":"object","properties":{"loyaltyProgram":{"description":"Loyalty program fields to update.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateLoyaltyProgramRequest","description":""},"com.wixpress.loyalty.program.UpdateLoyaltyProgramResponse":{"type":"object","properties":{"loyaltyProgram":{"description":"Updated loyalty program.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateLoyaltyProgramResponse","description":""},"com.wixpress.loyalty.program.PointsExpirationConfigurationChanged":{"type":"object","properties":{"loyaltyProgram":{"description":"Loyalty program.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pointsExpirationChanges":{"description":"Points expiration configuration changes","$ref":"#/components/schemas/com.wixpress.loyalty.program.PointsExpirationChanges","summary":"pointsExpirationChanges","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PointsExpirationConfigurationChanged","description":""},"com.wixpress.loyalty.program.PointsExpirationChanges":{"type":"object","properties":{"monthsOfInactivity":{"description":"","title":"monthsOfInactivity","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"expiringPointsPercentage":{"description":"","title":"expiringPointsPercentage","type":"integer","format":"int32","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PointsExpirationChanges","description":""},"google.protobuf.Int32Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int32Value","description":""},"com.wixpress.loyalty.program.ActivateLoyaltyProgramRequest":{"type":"object","properties":{},"title":"ActivateLoyaltyProgramRequest","description":""},"com.wixpress.loyalty.program.ActivateLoyaltyProgramResponse":{"type":"object","properties":{"loyaltyProgram":{"description":"Activated loyalty program.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActivateLoyaltyProgramResponse","description":""},"com.wixpress.loyalty.program.LoyaltyProgramActivated":{"type":"object","properties":{"loyaltyProgram":{"description":"Activated loyalty program.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"LoyaltyProgramActivated","description":""},"com.wixpress.loyalty.program.PauseLoyaltyProgramRequest":{"type":"object","properties":{},"title":"PauseLoyaltyProgramRequest","description":""},"com.wixpress.loyalty.program.PauseLoyaltyProgramResponse":{"type":"object","properties":{"loyaltyProgram":{"description":"Paused loyalty program.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PauseLoyaltyProgramResponse","description":""},"com.wixpress.loyalty.program.GetLoyaltyProgramDescriptionRequest":{"type":"object","properties":{"fields":{"description":"List of description fields to retrieve. Supported values: `description`, `updatedDate`.","maxItems":2,"title":"fields","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetLoyaltyProgramDescriptionRequest","description":""},"com.wixpress.loyalty.program.GetLoyaltyProgramDescriptionResponse":{"type":"object","properties":{"description":{"description":"Retrieved loyalty program description.","title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedDate":{"description":"Date and time of the latest description update.","title":"updatedDate","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetLoyaltyProgramDescriptionResponse","description":""},"com.wixpress.loyalty.program.UpdateLoyaltyProgramDescriptionRequest":{"type":"object","properties":{"description":{"description":"Loyalty program description to update.","minLength":1,"maxLength":1000000,"title":"description","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"UpdateLoyaltyProgramDescriptionRequest","description":""},"com.wixpress.loyalty.program.UpdateLoyaltyProgramDescriptionResponse":{"type":"object","properties":{},"title":"UpdateLoyaltyProgramDescriptionResponse","description":""},"com.wixpress.loyalty.program.LoyaltyProgramDescriptionUpdated":{"type":"object","properties":{},"title":"LoyaltyProgramDescriptionUpdated","description":""},"com.wixpress.loyalty.program.GetLoyaltyProgramPremiumFeaturesRequest":{"type":"object","properties":{},"title":"GetLoyaltyProgramPremiumFeaturesRequest","description":""},"com.wixpress.loyalty.program.GetLoyaltyProgramPremiumFeaturesResponse":{"type":"object","properties":{"loyaltyProgram":{"description":"Set to true if user has loyalty program premium feature","readOnly":true,"title":"loyaltyProgram","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"tiers":{"description":"Set to true if user has tiers premium feature","readOnly":true,"title":"tiers","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"pointsExpiration":{"description":"Set to true if user has points expiration premium feature","readOnly":true,"title":"pointsExpiration","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"GetLoyaltyProgramPremiumFeaturesResponse","description":""},"com.wixpress.loyalty.program.EnablePointsExpirationRequest":{"type":"object","properties":{},"title":"EnablePointsExpirationRequest","description":""},"com.wixpress.loyalty.program.EnablePointsExpirationResponse":{"type":"object","properties":{"loyaltyProgram":{"description":"Loyalty program with enabled points expiration feature.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EnablePointsExpirationResponse","description":""},"com.wixpress.loyalty.program.PointsExpirationEnabled":{"type":"object","properties":{"loyaltyProgram":{"description":"Loyalty program.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PointsExpirationEnabled","description":""},"com.wixpress.loyalty.program.DisablePointsExpirationRequest":{"type":"object","properties":{},"title":"DisablePointsExpirationRequest","description":""},"com.wixpress.loyalty.program.DisablePointsExpirationResponse":{"type":"object","properties":{"loyaltyProgram":{"description":"Loyalty program with disabled points expiration feature.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DisablePointsExpirationResponse","description":""},"com.wixpress.loyalty.program.PointsExpirationDisabled":{"type":"object","properties":{"loyaltyProgram":{"description":"Loyalty program.","$ref":"#/components/schemas/com.wixpress.loyalty.program.LoyaltyProgram","summary":"loyaltyProgram","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"PointsExpirationDisabled","description":""},"com.wixpress.metasite.event.api.MetaSiteSpecialEvent":{"type":"object","properties":{"metaSiteId":{"description":"A meta site id.","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A meta site version. Monotonically increasing.","title":"version","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"timestamp":{"description":"A timestamp of the event.","title":"timestamp","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"assets":{"description":"A list of \"assets\" (applications). The same as MetaSiteContext.","maxItems":400,"title":"assets","type":"array","items":{"$ref":"#/components/schemas/com.wixpress.metasite.event.api.Asset"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MetaSiteSpecialEvent","description":"","oneOf":[{"description":"","summary":"payload","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSiteSpecialEvent.payload"}]},"com.wixpress.metasite.event.api.MetaSiteSpecialEvent.payload":{"type":"object","title":"payload","properties":{"siteCreated":{"description":"Emitted on a meta site creation.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteCreated","summary":"siteCreated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteTransferred":{"description":"Emitted on a meta site transfer completion.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteTransferred","summary":"siteTransferred","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteDeleted":{"description":"Emitted on a meta site deletion.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteDeleted","summary":"siteDeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteUndeleted":{"description":"Emitted on a meta site restoration.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteUndeleted","summary":"siteUndeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"sitePublished":{"description":"Emitted on the first* publish of the meta site (* switching from unpublished to published state).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SitePublished","summary":"sitePublished","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteUnpublished":{"description":"Emitted on a meta site unpublish.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteUnpublished","summary":"siteUnpublished","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMarkedAsTemplate":{"description":"Emitted when meta site is marked as template.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteMarkedAsTemplate","summary":"siteMarkedAsTemplate","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteMarkedAsWixSite":{"description":"Emitted when meta site is marked as a WixSite.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteMarkedAsWixSite","summary":"siteMarkedAsWixSite","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceProvisioned":{"description":"Emitted when an application is provisioned (installed).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.ServiceProvisioned","summary":"serviceProvisioned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"serviceRemoved":{"description":"Emitted when an application is removed (uninstalled).","$ref":"#/components/schemas/com.wixpress.metasite.event.api.ServiceRemoved","summary":"serviceRemoved","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteRenamedPayload":{"description":"Emitted when meta site name (URL slug) is changed.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteRenamed","summary":"siteRenamedPayload","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"hardDeleted":{"description":"Emitted when meta site was permanently deleted.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteHardDeleted","summary":"hardDeleted","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespaceChanged":{"description":"Emitted on a namespace change.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.NamespaceChanged","summary":"namespaceChanged","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"studioAssigned":{"description":"Emitted when Studio is attached.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.StudioAssigned","summary":"studioAssigned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"studioUnassigned":{"description":"Emitted when Studio is detached.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.StudioUnassigned","summary":"studioUnassigned","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.metasite.event.api.Asset":{"type":"object","properties":{"appDefId":{"description":"An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"An instance id. For legacy reasons may be UUID or a string.","maxLength":200,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"state":{"description":"An application state.","title":"state","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.Asset.State","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Asset","description":""},"com.wixpress.metasite.event.api.Asset.State":{"type":"string","description":"","title":"State","enum":["UNKNOWN","ENABLED","DISABLED","PENDING","DEMO"]},"com.wixpress.metasite.event.api.SiteCreated":{"type":"object","properties":{"originTemplateId":{"description":"A template identifier (empty if not created from a template).","maxLength":36,"title":"originTemplateId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"ownerId":{"description":"An account id of the owner.","format":"GUID","title":"ownerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"context":{"description":"A context in which meta site was created.","title":"context","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.SiteCreatedContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originMetaSiteId":{"description":"A meta site id from which this site was created.\n\nIn case of a creation from a template it's a template id.\nIn case of a site duplication (\"Save As\" in dashboard or duplicate in UM) it's an id of a source site.","format":"GUID","title":"originMetaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"siteName":{"description":"A meta site name (URL slug).","maxLength":20,"title":"siteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"namespace":{"description":"A namespace.","title":"namespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteCreated","description":""},"com.wixpress.metasite.event.api.SiteCreatedContext":{"type":"string","description":"","title":"SiteCreatedContext","enum":["OTHER","FROM_TEMPLATE","DUPLICATE_BY_SITE_TRANSFER","DUPLICATE","OLD_SITE_TRANSFER","FLASH"]},"com.wixpress.metasite.event.api.MetaSite.Namespace":{"type":"string","description":"","title":"Namespace","enum":["UNKNOWN_NAMESPACE","WIX","SHOUT_OUT","ALBUMS","WIX_STORES_TEST_DRIVE","HOTELS","CLUBS","ONBOARDING_DRAFT","DEV_SITE","LOGOS","VIDEO_MAKER","PARTNER_DASHBOARD","DEV_CENTER_COMPANY","HTML_DRAFT","SITELESS_BUSINESS","CREATOR_ECONOMY","DASHBOARD_FIRST","ANYWHERE","HEADLESS","ACCOUNT_MASTER_CMS","RISE","BRANDED_FIRST"]},"com.wixpress.metasite.event.api.SiteTransferred":{"type":"object","properties":{"oldOwnerId":{"description":"A previous owner id (user that transfers meta site).","format":"GUID","title":"oldOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newOwnerId":{"description":"A new owner id (user that accepts meta site).","format":"GUID","title":"newOwnerId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteTransferred","description":"Site transferred to another user."},"com.wixpress.metasite.event.api.SiteDeleted":{"type":"object","properties":{"deleteContext":{"description":"A deletion context.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext","summary":"deleteContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteDeleted","description":"Soft deletion of the meta site. Could be restored."},"com.wixpress.metasite.event.api.DeleteContext":{"type":"object","properties":{"dateDeleted":{"description":"When the meta site was deleted.","title":"dateDeleted","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteStatus":{"description":"A status.","title":"deleteStatus","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext.DeleteStatus","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deleteOrigin":{"description":"A reason (flow).","maxLength":255,"title":"deleteOrigin","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"initiatorId":{"description":"A service that deleted it.","maxLength":255,"title":"initiatorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DeleteContext","description":""},"com.wixpress.metasite.event.api.DeleteContext.DeleteStatus":{"type":"string","description":"","title":"DeleteStatus","enum":["UNKNOWN","TRASH","DELETED","PENDING_PURGE"]},"com.wixpress.metasite.event.api.SiteUndeleted":{"type":"object","properties":{},"title":"SiteUndeleted","description":"Restoration of the meta site."},"com.wixpress.metasite.event.api.SitePublished":{"type":"object","properties":{},"title":"SitePublished","description":"First publish of a meta site. Or subsequent publish after unpublish."},"com.wixpress.metasite.event.api.SiteUnpublished":{"type":"object","properties":{"urls":{"description":"A list of URLs previously associated with the meta site.","maxLength":4000,"maxItems":10000,"title":"urls","type":"array","items":{"type":"string"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteUnpublished","description":""},"com.wixpress.metasite.event.api.SiteMarkedAsTemplate":{"type":"object","properties":{},"title":"SiteMarkedAsTemplate","description":""},"com.wixpress.metasite.event.api.SiteMarkedAsWixSite":{"type":"object","properties":{},"title":"SiteMarkedAsWixSite","description":""},"com.wixpress.metasite.event.api.ServiceProvisioned":{"type":"object","properties":{"appDefId":{"description":"Either UUID or EmbeddedServiceType.","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"Not only UUID. Something here could be something weird.","maxLength":36,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originInstanceId":{"description":"An instance id from which this instance is originated.","maxLength":36,"title":"originInstanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A version.","maxLength":50,"title":"version","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceProvisioned","description":""},"com.wixpress.metasite.event.api.ServiceRemoved":{"type":"object","properties":{"appDefId":{"description":"Either UUID or EmbeddedServiceType.","maxLength":36,"title":"appDefId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"instanceId":{"description":"Not only UUID. Something here could be something weird.","maxLength":36,"title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"version":{"description":"A version.","maxLength":50,"title":"version","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ServiceRemoved","description":""},"com.wixpress.metasite.event.api.SiteRenamed":{"type":"object","properties":{"newSiteName":{"description":"A new meta site name (URL slug).","maxLength":20,"title":"newSiteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"oldSiteName":{"description":"A previous meta site name (URL slug).","maxLength":255,"title":"oldSiteName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteRenamed","description":"Rename of the site. Meaning, free public url has been changed as well."},"com.wixpress.metasite.event.api.SiteHardDeleted":{"type":"object","properties":{"deleteContext":{"description":"A deletion context.","$ref":"#/components/schemas/com.wixpress.metasite.event.api.DeleteContext","summary":"deleteContext","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"SiteHardDeleted","description":"Hard deletion of the meta site.\n\nCould not be restored. Therefore it's desirable to cleanup data."},"com.wixpress.metasite.event.api.NamespaceChanged":{"type":"object","properties":{"oldNamespace":{"description":"A previous namespace.","title":"oldNamespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newNamespace":{"description":"A new namespace.","title":"newNamespace","type":"string","$ref":"#/components/schemas/com.wixpress.metasite.event.api.MetaSite.Namespace","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"NamespaceChanged","description":""},"com.wixpress.metasite.event.api.StudioAssigned":{"type":"object","properties":{},"title":"StudioAssigned","description":"Assigned Studio editor"},"com.wixpress.metasite.event.api.StudioUnassigned":{"type":"object","properties":{},"title":"StudioUnassigned","description":"Unassigned Studio editor"},"google.protobuf.Empty":{"type":"object","properties":{},"title":"Empty","description":""},"com.wixpress.premium.featuresmanager.api.v1.FeatureEvent":{"type":"object","properties":{"timestamp":{"description":"Timestamp of the event in\n[UTC time](https://en.wikipedia.org/wiki/Coordinated_Universal_Time).","title":"timestamp","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FeatureEvent","description":"","oneOf":[{"description":"","summary":"event","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.FeatureEvent.event"}]},"com.wixpress.premium.featuresmanager.api.v1.FeatureEvent.event":{"type":"object","title":"event","properties":{"enabled":{"description":"Information about an event that makes a feature eligible to the user.\nTriggered for example, for new features or when a feature is reassigned\nto an account or a site.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.FeatureEnabled","summary":"enabled","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"disabled":{"description":"Information about an event that disables a feature for the user.\nTriggered for example, when a feature is unassigned from a site,\nreassigned to a different site, or the user switched to a different contract.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.FeatureDisabled","summary":"disabled","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updated":{"description":"Information about an event that updates a feature. An `updated` event\nis triggered for example by the\n[Report Quota Usage](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/report-quota-usage)\nand [Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter)\nendpoints.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.FeatureUpdated","summary":"updated","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cancelled":{"description":"Information about an event that cancels a feature for the user.\nTriggered for example, when a feature is canceled, transferred to\nanother account, or the user switched to a different contract.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.FeatureCancelled","summary":"cancelled","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.premium.featuresmanager.api.v1.FeatureEnabled":{"type":"object","properties":{"feature":{"description":"Enabled feature.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.Feature","summary":"feature","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"transferredFromAccount":{"description":"Information about a transfer from another account.\n__Deprecated__. Use `reason.transferred_from_another_account` instead.","format":"GUID","title":"transferredFromAccount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reassignedFromMetasite":{"description":"Information about a transfer from another site.\n__Deprecated__. Use `reason.reassigned_from_site` instead.","format":"GUID","title":"reassignedFromMetasite","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FeatureEnabled","description":"Feature created or enabled after disabled state","oneOf":[{"description":"","summary":"reason","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.FeatureEnabled.reason"}]},"com.wixpress.premium.featuresmanager.api.v1.FeatureEnabled.reason":{"type":"object","title":"reason","properties":{"transferredFromAnotherAccount":{"description":"Information about a transfer from another account.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.TransferredFromAnotherAccountReason","summary":"transferredFromAnotherAccount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reassignedFromSite":{"description":"Information about a transfer from another site.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.ReassignedFromSiteReason","summary":"reassignedFromSite","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"assignedFromFloating":{"description":"Information about a feature that hadn't been assigned to site.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.AssignedFromFloatingReason","summary":"assignedFromFloating","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"newFeature":{"description":"Information about the new feature.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.NewFeatureReason","summary":"newFeature","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contractSwitched":{"description":"Information about the contract switch.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.ContractSwitchedReason","summary":"contractSwitched","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"manualFeatureCreation":{"description":"Information about the manually created features.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.ManualFeatureCreationReason","summary":"manualFeatureCreation","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"migratedFromLegacy":{"description":"Information about a feature that was migrated from legacy.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.MigratedFromLegacyReason","summary":"migratedFromLegacy","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.premium.featuresmanager.api.v1.Feature":{"type":"object","properties":{"id":{"description":"ID of the feature. __Note:__ Isn't unique. For example, all features that\nare available to free Wix accounts or site in some capacity have\n`{\"id\": \"DEFAULT\"}`. Use `uniqueName` as unique identifier for a feature.","readOnly":true,"title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"uniqueName":{"description":"Unique name of the feature. Only lower case letters, numbers, and dashes\n`-` are supported. Used in the endpoints of the\n[Features Manager API](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/introduction)\nto specify the feature. Not visible to customers. We recommend to start\nthe unique name with a prefix describing your organization or Wix company.\nFor example, `bookings` or `crm`.\n\nMin: 2 characters\nMax: 50 characters","minLength":2,"maxLength":50,"title":"uniqueName","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"context":{"description":"Information about whether the feature belongs to a Wix account or site.\nAccount features have `context.userId`. Site features have `context.metaSiteId` in case\nthey're assigned to a specific site. Site features that aren't assigned to\na specific site have neither ID.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.FeatureContext","summary":"context","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"createdAt":{"description":"Deprecated.","readOnly":true,"title":"createdAt","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"updatedAt":{"description":"Deprecated.","readOnly":true,"title":"updatedAt","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"quotaInfo":{"description":"Information about how often customers can use the feature during a specific\nperiod. Available only for quota features.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.QuotaInfo","summary":"quotaInfo","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"enabled":{"description":"Whether the customer is currently allowed to use the feature.\n`true` means that the customer can use the feature. This means a boolean\nfeature is active or a quota feature has remaining usage.\n`false` means that the customer can't use the feature.\nThis means a boolean feature isn't active or a quota feature doesn't\nhave remaining usage.","title":"enabled","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"subscriptionId":{"description":"ID of the [subscription](https://bo.wix.com/wix-docs/rest/premium/premium-subscriptions-manager/subscription-object)\nto which the feature instance belongs.","format":"GUID","title":"subscriptionId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metadata":{"description":"Metadata of the feature. Wix Premium uses the metadata object to indicate\nthat customers who purchase a product with the feature also get\naccess to an additional product. For these bundled products `metadata`\nlooks like this: `{\"tpa\": \"{\"appDefId\": \"sample-app-def-id-1234567890\", \"vendorProductId\": \"sample-productId\"}}\"`.\nBut you can use the `metadata` property for other purposes, too.","title":"metadata","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"type":"string"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Feature","description":"","oneOf":[{"description":"","summary":"quantityInfo","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.Feature.quantityInfo"}]},"com.wixpress.premium.featuresmanager.api.v1.Feature.quantityInfo":{"type":"object","title":"quantityInfo","properties":{"booleanFeature":{"description":"Deprecated. Use `enabled` instead.","$ref":"#/components/schemas/com.wixpress.premium.productcatalog.api.v1.feature.BooleanFeature","summary":"booleanFeature","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}},"quotaFeature":{"description":"Deprecated. Use `quotaInfo` instead.","$ref":"#/components/schemas/com.wixpress.premium.productcatalog.api.v1.feature.QuotaFeature","summary":"quotaFeature","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA","deprecated":{}}}}},"com.wixpress.premium.featuresmanager.api.v1.FeatureContext":{"type":"object","properties":{"userId":{"description":"ID of the Wix account that the feature instance belongs to.\nAvailable for both site and account level feature instances.","format":"GUID","title":"userId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metaSiteId":{"description":"ID of the meta site that the feature instance is assigned to.\nOnly available for site level feature instances that are assigned to a Wix\nsite. Not available for account level and unassigned site level feature\ninstances.","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FeatureContext","description":"Context this feature is currently connected to.\nNote: Do not confuse with feature scope which is configured in the product catalog\nand defines in which context the product can be used"},"com.wixpress.premium.productcatalog.api.v1.feature.BooleanFeature":{"type":"object","properties":{},"title":"BooleanFeature","description":"A feature that can be either \"enabled\" or \"disabled\". The default/freemium setting is always OFF, and the premium setting is always ON (meaning, unlimited usage without tracking).\nA boolean feature is similar to a quantitive feature with a default limit of 0 and UNLIMITED premium limit (although a bit simplified)."},"com.wixpress.premium.productcatalog.api.v1.feature.QuotaFeature":{"type":"object","properties":{"limit":{"description":"Default (or Freemium) quota limitation. if left undefined the free feature has unlimited amount.","title":"limit","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"period":{"description":"Periodic time-frame to reset the usage counter. You may use NO_PERIOD if counter shouldn't be reset.","title":"period","type":"string","$ref":"#/components/schemas/com.wixpress.premium.productcatalog.api.v1.feature.FeaturePeriodEnum.FeaturePeriod","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"units":{"description":"Usage measurement units (seconds? MBs? unitless?). Usage reported will be counted in multiples of this basic unit.","title":"units","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QuotaFeature","description":"A feature with a periodic usage limitation. The default limit is defined in the Feature Spec, the Premium limits are defined in the respective ProductFeature."},"google.protobuf.Int64Value":{"type":"object","properties":{"value":{"description":"","title":"value","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Int64Value","description":""},"com.wixpress.premium.productcatalog.api.v1.feature.FeaturePeriodEnum.FeaturePeriod":{"type":"string","description":"Determines the reset cycle of the feature usage.","title":"FeaturePeriod","enum":["NO_PERIOD","MILLISECOND","SECOND","MINUTE","HOUR","DAY","WEEK","MONTH","YEAR"]},"com.wixpress.premium.featuresmanager.api.v1.QuotaInfo":{"type":"object","properties":{"limit":{"description":"How often the customer is allowed to use the feature during the specified\nperiod. `null` means that the customer has unlimited access to the feature.","title":"limit","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"period":{"description":"Time frame for the usage limitation. `NO_PERIOD` means that `remainingUsage`\nisn't automatically reset to the feature's `limit` after a specific period.\nYou may still manually call\n[Reset Usage Counter](https://bo.wix.com/wix-docs/rest/premium/premium-features-manager/reset-usage-counter).","title":"period","type":"string","$ref":"#/components/schemas/com.wixpress.premium.productcatalog.api.v1.feature.FeaturePeriodEnum.FeaturePeriod","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"currentUsage":{"description":"How often the customer has used the feature during the current\nperiod.","title":"currentUsage","type":"integer","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"remainingUsage":{"description":"How often the customer can still use the feature during the current\nperiod. `null` means that the customer has unlimited access to the feature.","title":"remainingUsage","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"QuotaInfo","description":""},"com.wixpress.premium.featuresmanager.api.v1.TransferredFromAnotherAccountReason":{"type":"object","properties":{"transferredFromAccount":{"description":"Information about a transfer from another account.","format":"GUID","title":"transferredFromAccount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TransferredFromAnotherAccountReason","description":"Subscription transferred from another account, features on the current account were enabled."},"com.wixpress.premium.featuresmanager.api.v1.ReassignedFromSiteReason":{"type":"object","properties":{"reassignedFromMetasite":{"description":"Information about a transfer from another site.","format":"GUID","title":"reassignedFromMetasite","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReassignedFromSiteReason","description":"Subscription moved from one site to another in the same account, features enabled on the target site"},"com.wixpress.premium.featuresmanager.api.v1.AssignedFromFloatingReason":{"type":"object","properties":{},"title":"AssignedFromFloatingReason","description":"Subscription was floating and assigned to site, features enabled on the target site"},"com.wixpress.premium.featuresmanager.api.v1.NewFeatureReason":{"type":"object","properties":{},"title":"NewFeatureReason","description":"New subscription created and features created as enabled"},"com.wixpress.premium.featuresmanager.api.v1.ContractSwitchedReason":{"type":"object","properties":{},"title":"ContractSwitchedReason","description":"Subscription was upgraded or downgraded, as a result new features enabled, missing features disabled , quantities are updated"},"com.wixpress.premium.featuresmanager.api.v1.ManualFeatureCreationReason":{"type":"object","properties":{},"title":"ManualFeatureCreationReason","description":"a call to CreateFeature in features-writer, creates feature that is not attached to subscription"},"com.wixpress.premium.featuresmanager.api.v1.MigratedFromLegacyReason":{"type":"object","properties":{},"title":"MigratedFromLegacyReason","description":"Subscription created due to migration from old premium model"},"com.wixpress.premium.featuresmanager.api.v1.FeatureDisabled":{"type":"object","properties":{"feature":{"description":"Disabled feature. Includes information about the feature's new state,\npossibly its new context.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.Feature","summary":"feature","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"metaSiteId":{"description":"ID of the meta site for which the feature has been disabled.","format":"GUID","title":"metaSiteId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FeatureDisabled","description":"Feature disabled and can be enabled in the future","oneOf":[{"description":"","summary":"reason","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.FeatureDisabled.reason"}]},"com.wixpress.premium.featuresmanager.api.v1.FeatureDisabled.reason":{"type":"object","title":"reason","properties":{"unassingedToFloating":{"description":"Information about a feature that's no longer assigned to a site.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.UnAssingedToFloatingReason","summary":"unassingedToFloating","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"replacedByAnotherSubscription":{"description":"Information about a feature that's been replaced by a feature from a\ndifferent subscription.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.ReplacedByAnotherSubscriptionReason","summary":"replacedByAnotherSubscription","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"reassignedToAnotherSite":{"description":"Information about a feature that's been reassigned to a different\nsite.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.ReassignedToAnotherSiteReason","summary":"reassignedToAnotherSite","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.premium.featuresmanager.api.v1.UnAssingedToFloatingReason":{"type":"object","properties":{},"title":"UnAssingedToFloatingReason","description":"Subscription was unassigned from the site and moved into floating state"},"com.wixpress.premium.featuresmanager.api.v1.ReplacedByAnotherSubscriptionReason":{"type":"object","properties":{},"title":"ReplacedByAnotherSubscriptionReason","description":"Another subscription was assigned to the site, causing existing features on this site to be disabled"},"com.wixpress.premium.featuresmanager.api.v1.ReassignedToAnotherSiteReason":{"type":"object","properties":{"reassignedToMetasite":{"description":"Information about a transfer to the site.","format":"GUID","title":"reassignedToMetasite","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ReassignedToAnotherSiteReason","description":"Subscription was assigned to another site, causing features on the origin site to be disabled."},"com.wixpress.premium.featuresmanager.api.v1.FeatureUpdated":{"type":"object","properties":{"feature":{"description":"Updated feature. Includes information about the feature's new state and\npossibly its new context.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.Feature","summary":"feature","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FeatureUpdated","description":"Feature updated, for example Quota was increased due to upgrade","oneOf":[{"description":"","summary":"previousQuantityInfo","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.FeatureUpdated.previousQuantityInfo"},{"description":"","summary":"reason","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.FeatureUpdated.reason"}]},"com.wixpress.premium.featuresmanager.api.v1.FeatureUpdated.previousQuantityInfo":{"type":"object","title":"previousQuantityInfo","properties":{"booleanFeature":{"description":"Information about a feature that doesn't have a usage quota.","$ref":"#/components/schemas/com.wixpress.premium.productcatalog.api.v1.feature.BooleanFeature","summary":"booleanFeature","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"quotaFeature":{"description":"Information about a feature that has a usage quota.","$ref":"#/components/schemas/com.wixpress.premium.productcatalog.api.v1.feature.QuotaFeature","summary":"quotaFeature","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.premium.featuresmanager.api.v1.FeatureUpdated.reason":{"type":"object","title":"reason","properties":{"contractSwitched":{"description":"Information about the contract switch.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.ContractSwitchedReason","summary":"contractSwitched","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.premium.featuresmanager.api.v1.FeatureCancelled":{"type":"object","properties":{"feature":{"description":"Canceled feature.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.Feature","summary":"feature","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"transferredToAccount":{"description":"Information about a transfer to the account.\n__Deprecated__. Use `reason.transferred_to_account` instead.","format":"GUID","title":"transferredToAccount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"FeatureCancelled","description":"Feature was permanently cancelled","oneOf":[{"description":"","summary":"reason","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.FeatureCancelled.reason"}]},"com.wixpress.premium.featuresmanager.api.v1.FeatureCancelled.reason":{"type":"object","title":"reason","properties":{"transferredToAnotherAccount":{"description":"Information about a transfer to the account.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.TransferredToAnotherAccountReason","summary":"transferredToAnotherAccount","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"contractSwitched":{"description":"Information about the contract switch.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.ContractSwitchedReason","summary":"contractSwitched","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"cancelRequest":{"description":"Information about the feature cancellation.","$ref":"#/components/schemas/com.wixpress.premium.featuresmanager.api.v1.CancelRequestedReason","summary":"cancelRequest","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.premium.featuresmanager.api.v1.TransferredToAnotherAccountReason":{"type":"object","properties":{"transferredToAccount":{"description":"Information about a transfer to the account.","format":"GUID","title":"transferredToAccount","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"TransferredToAnotherAccountReason","description":"Subscription was transferred to another account, features in the origin account were cancelled"},"com.wixpress.premium.featuresmanager.api.v1.CancelRequestedReason":{"type":"object","properties":{},"title":"CancelRequestedReason","description":"Cancellation was requested from the subscription manager api, might be a result of billing event, or direct call"},"wix.common.domainevents.DomainEvent":{"type":"object","properties":{"id":{"description":"Unique event ID.\nAllows clients to ignore duplicate webhooks.","title":"id","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityFqdn":{"description":"Assumes actions are also always typed to an entity_type\nExample: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction","title":"entityFqdn","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"slug":{"description":"This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)\nThis is although the created/updated/deleted notion is duplication of the oneof types\nExample: created/updated/deleted/started/completed/email_opened","title":"slug","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityId":{"description":"ID of the entity associated with the event.","title":"entityId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventTime":{"description":"Event timestamp.","title":"eventTime","type":"string","format":"date-time","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"triggeredByAnonymizeRequest":{"description":"Whether the event was triggered as a result of a privacy regulation application\n(for example, GDPR).","title":"triggeredByAnonymizeRequest","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"originatedFrom":{"description":"If present, indicates the action that triggered the event.","title":"originatedFrom","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"entityEventSequence":{"description":"A sequence number defining the order of updates to the underlying entity.\nFor example, given that some entity was updated at 16:00 and than again at 16:01,\nit is guaranteed that the sequence number of the second update is strictly higher than the first.\nAs the consumer, you can use this value to ensure that you handle messages in the correct order.\nTo do so, you will need to persist this number on your end, and compare the sequence number from the\nmessage against the one you have stored. Given that the stored number is higher, you should ignore the message.","title":"entityEventSequence","type":"integer","format":"int64","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"DomainEvent","description":"","oneOf":[{"description":"","summary":"body","$ref":"#/components/schemas/wix.common.domainevents.DomainEvent.body"}]},"wix.common.domainevents.DomainEvent.body":{"type":"object","title":"body","properties":{"createdEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityCreatedEvent","summary":"createdEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"updatedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityUpdatedEvent","summary":"updatedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"deletedEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.EntityDeletedEvent","summary":"deletedEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"actionEvent":{"description":"","$ref":"#/components/schemas/wix.common.domainevents.ActionEvent","summary":"actionEvent","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"wix.common.domainevents.EntityCreatedEvent":{"type":"object","properties":{"entityAsJson":{"description":"","title":"entityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityCreatedEvent","description":""},"google.protobuf.BoolValue":{"type":"object","properties":{"value":{"description":"","title":"value","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"BoolValue","description":""},"wix.common.domainevents.EntityUpdatedEvent":{"type":"object","properties":{"currentEntityAsJson":{"description":"Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.\nThis means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.\nWe don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.","title":"currentEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityUpdatedEvent","description":""},"google.protobuf.Value":{"type":"object","properties":{},"title":"Value","description":"","oneOf":[{"description":"","summary":"kind","$ref":"#/components/schemas/google.protobuf.Value.kind"}]},"google.protobuf.Value.kind":{"type":"object","title":"kind","properties":{"nullValue":{"description":"","title":"nullValue","$ref":"#/components/schemas/google.protobuf.NullValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"numberValue":{"description":"","title":"numberValue","type":"number","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"stringValue":{"description":"","title":"stringValue","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"boolValue":{"description":"","title":"boolValue","type":"boolean","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"structValue":{"description":"","title":"structValue","type":"object","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"listValue":{"description":"","title":"listValue","$ref":"#/components/schemas/google.protobuf.ListValue","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"google.protobuf.NullValue":{"type":"string","description":"","title":"NullValue","enum":["NULL_VALUE"]},"google.protobuf.Struct":{"type":"object","properties":{"fields":{"description":"","title":"fields","type":"object","format":"map","properties":{"key":{"type":"string"},"value":{"$ref":"#/components/schemas/google.protobuf.Value"}},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"Struct","description":""},"google.protobuf.ListValue":{"type":"object","properties":{"values":{"description":"","title":"values","type":"array","items":{"$ref":"#/components/schemas/google.protobuf.Value"},"x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ListValue","description":""},"wix.common.domainevents.EntityDeletedEvent":{"type":"object","properties":{"deletedEntityAsJson":{"description":"Entity that was deleted","title":"deletedEntityAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"EntityDeletedEvent","description":""},"wix.common.domainevents.ActionEvent":{"type":"object","properties":{"bodyAsJson":{"description":"","title":"bodyAsJson","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"ActionEvent","description":""},"com.wixpress.iptf.v1.webhooks.MessageEnvelope":{"type":"object","properties":{"instanceId":{"description":"App instance ID.","format":"GUID","title":"instanceId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"eventType":{"description":"Event type.","maxLength":150,"title":"eventType","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"identity":{"description":"The identification type and identity data.","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData","summary":"identity","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"data":{"description":"Stringify payload.","title":"data","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"MessageEnvelope","description":""},"com.wixpress.iptf.v1.webhooks.IdentificationData":{"type":"object","properties":{"identityType":{"description":"","readOnly":true,"title":"identityType","type":"string","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}},"title":"IdentificationData","description":"","oneOf":[{"description":"","summary":"id","$ref":"#/components/schemas/com.wixpress.iptf.v1.webhooks.IdentificationData.id"}]},"com.wixpress.iptf.v1.webhooks.IdentificationData.id":{"type":"object","title":"id","properties":{"anonymousVisitorId":{"description":"ID of a site visitor that has not logged in to the site.","format":"GUID","title":"anonymousVisitorId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"memberId":{"description":"ID of a site visitor that has logged in to the site.","format":"GUID","title":"memberId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"wixUserId":{"description":"ID of a Wix user (site owner, contributor, etc.).","format":"GUID","title":"wixUserId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}},"appId":{"description":"ID of an app.","format":"GUID","title":"appId","type":"string","x-wix-docs":{"exposure":"PUBLIC","maturity":"GA"}}}},"com.wixpress.iptf.v1.webhooks.IdentificationData.WebhookIdentityType":{"type":"string","description":"","title":"WebhookIdentityType","enum":["UNKNOWN","ANONYMOUS_VISITOR","MEMBER","WIX_USER","APP"]}}},"title":"Program","description":"A loyalty program allows sites to maintain customer reward accounts. Site owners can create a\nloyalty program to increase customer retention. Read more about the loyalty program in\n[this overview](https://support.wix.com/en/article/wix-loyalty-program-an-overview).","fqdn":"wix.loyalty.v1.program"},"articles":[{"displayName":"Introduction","slugifyName":"introduction","content":"# About Loyalty Program\n\nThe loyalty program API allows a site owner to activate their site's loyalty program and manage its details, like the point name and point icon. The loyalty program must be `ACTIVE` to start creating customer loyalty accounts and tracking their point balances.\n\nWith the loyalty program API, you can:\n+ Activate a loyalty program.\n+ Update the name and icon for the program's points.\n+ Retrieve a loyalty program.\n\n> **Note:**\n> In order to use the loyalty program API, the Wix site owner must first install the Wix Loyalty Program app to their site. A site owner can install the app through their [dashboard](fallback::https://www.wix.com/my-account/site-selector/?buttonText=Select%20Site&title=Select%20a%20Site&autoSelectOnSingleSite=true&actionUrl=https:%2F%2Fwww.wix.com%2Fdashboard%2F%7B%7BmetaSiteId%7D%7D%2Floyalty-accounts/wizard/) or the [Wix App Market](fallback::https://www.wix.com/app-market/loyalty)."}]},"reviewStatus":"APPROVED","isLocked":true,"metadata":{"packageVersion":""}}

Get Loyalty Program

Permission Scopes