v0.8.4

Subscriptions Error Catalogue

Client Errors

These are the errors returned when the request cannot be accepted because of an error on request info

400 Bad Request - General Client Errors

CodeDescriptionPossible actions
BAD_REQUESTGeneral bad request errorCheck request format and parameters
INVALID_MSISDNThe provided MSISDN is not validCheck the MSISDN format
INVALID_IMSIThe provided IMSI is not validCheck the IMSI format
INVALID_DONOR_OPERATORThe provided donor operator id is not validCheck the donor operator id format
INVALID_PHONE_NUMBERThe provided phone number is not validCheck the phone number format
MISSING_QUERY_PARAMSThe request is missing required query parametersCheck endpoint documentation
MULTIPLE_PATCH_SAME_PATHMultiple patch operations for the same path are not allowedReview patch operations and remove duplicates
UNSUPPORTED_SUBSCRIPTION_TYPESubscription type not supportedVerify subscription type is supported by this endpoint
SEGMENT_VALIDATION_ERRORSegment value prefix is incompatible with the subscription typeUse the prefix required for the subscription type
DEVICE_ACQUISITION_TYPE_NOT_SUPPORTED_FOR_PAYMENT_PLANSDevice acquisition type does not support payment plansVerify the device supports financing before requesting its payment plans

400 Bad Request - Lifecycle & State Validation

CodeDescriptionPossible actions
PROMOTION_INVALID_SUBSCRIPTION_STATUSSubscription status does not allow promotions to be addedCheck subscription status before adding promotions
SUBSCRIPTION_STATUS_DOES_NOT_ALLOW_OPERATIONSubscription status does not allow the requested promotion operationVerify subscription is in correct status for operation
SUBSCRIPTION_STATUS_DOES_NOT_ALLOW_DEACTIVATIONSubscription status does not allow deactivationVerify subscription status allows deactivation
PROMOTION_ACTIVATION_DATE_NOT_ALLOWEDSubscription status does not allow promotions to be programmedCheck subscription status supports scheduled promotions
PROMOTION_NOT_CANCELLABLEPromotion must be in status REQUESTED to be cancelledVerify promotion is in REQUESTED status
PROMOTION_NOT_DEACTIVATABLEPromotion must be in status ACTIVE to be deactivatedVerify promotion is in ACTIVE status
INVALID_SUBSCRIPTION_STATUSSubscription must be active or pre-active to perform the operationCheck subscription status is ACTIVE or PRE_ACTIVE
SUBSCRIPTION_NOT_ACTIVESubscription must be activeCheck subscription status before retrying the operation
SUBSCRIPTION_DEACTIVATION_COMMITMENTS_DO_NOT_MATCHReceived commitments do not match subscription commitmentsVerify commitment identifiers belong to the subscription
OPERATION_NOT_SUPPORTEDThe requested operation type is not supportedCheck available operations for this subscription type
SUBSCRIPTION_NOT_SUPPORTEDSubscription type is not supported for bundle modificationOnly internally managed subscriptions can be added
ADD_ON_SUBSCRIPTION_NOT_ACTIVESubscription must be active to add an add-onCheck subscription status before adding an add-on
ADD_ON_UNSUPPORTED_ON_SECONDARY_AGILE_TVOnly primary AGILE_TV subscriptions can have add-onsAdd the add-on to the primary AGILE_TV subscription
BUNDLE_RELATED_INFO_REQUIREDBundle related info is required to retrieve add-on catalogue nameVerify subscription bundle related info before retrying
VALUE_ADDED_SERVICE_NOT_FOUNDValue added service provider product not foundVerify the add-on service configuration in catalogue
ADD_ON_ALREADY_TERMINATEDAdd-on is already terminatedCheck add-on status before retrying termination
ADD_ON_NOT_TERMINABLEAdd-on status does not allow terminationTerminate only add-ons in REQUESTED, PROVISIONING, or ACTIVE status
BLOCKING_ACTIONS_IN_PROGRESSBlocking actions in progressWait for in-progress commercial transactions to complete

400 Bad Request - Change Requests

CodeDescriptionPossible actions
NOT_ACTIVE_SUBSCRIPTION_NO_CRNot active subscription does not allow change requestSubscription must be active to create change requests
SUBSCRIPTION_TYPE_NO_CRSubscription type does not allow change requestsVerify subscription type supports change requests

400 Bad Request - Patch Operations

CodeDescriptionPossible actions
INVALID_PATCH_OPERATIONInvalid patch operationReview patch operation syntax
INVALID_PATCH_PATHInvalid patch pathCheck patch path is valid for the resource
INVALID_PATCH_REASONInvalid patch reasonProvide valid reason for patch operation
INVALID_PATCH_VALUEInvalid patch valueCheck patch value matches expected format

400 Bad Request - Device Insurance

CodeDescriptionPossible actions
DEVICE_ALREADY_INSUREDDevice is already insuredCheck if insurance already exists for this device
DEVICE_NOT_ALLOWED_TO_BE_INSURABLEDevice is not eligible for insurance because it is cancelled or feasibility rejected itVerify device status and model insurance feasibility. See Device status

400 Bad Request - Catalogue Validation

CodeDescriptionPossible actions
BUNDLE_DOES_NOT_INCLUDE_SUBSCRIPTION_TYPEThe bundled product is not compatible with the subscription typeCheck bundle includes the subscription type
MAX_SUBSCRIPTIONS_QUANTITY_EXCEEDEDThe requested quantity exceeds the maximum allowedReduce quantity or check bundle limits
MIN_SUBSCRIPTIONS_QUANTITY_NOT_REACHEDThe requested quantity is below the minimum allowedAdd the required subscription type or check bundle limits
TARIFF_NOT_COMPATIBLE_WITH_PROMOTIONTariff is not compatible with received promotionCheck promotion compatibility in +Catalogue
ADDON_NOT_COMPATIBLE_WITH_PROMOTIONAddon is not compatible with received promotionCheck promotion compatibility for the addon in +Catalogue
TARIFF_NOT_COMPATIBLE_WITH_FREE_UNITS_PACKAGETariff is not compatible with received free units packageCheck free units package compatibility in +Catalogue
TARIFF_NOT_COMPATIBLE_WITH_ADDONSTariff is not compatible with received addonsCheck addon compatibility in +Catalogue
COMMERCIAL_DEVICE_NOT_EXISTS_FOR_TARIFFCommercial device does not exist for given tariffVerify device is available for this tariff
COMMERCIAL_DEVICE_NOT_VALID_FOR_TARIFF_SALECommercial device is not valid for sale for given tariffVerify device sale validity dates in +Catalogue
COMMERCIAL_PRODUCT_DEVICES_QUANTITY_OUT_OF_RANGERequested commercial devices quantity is outside catalogue limitsCheck commercial product min/max devices in +Catalogue
TARIFF_NOT_COMPATIBLE_WITH_SUBSCRIPTION_TYPE_IN_BUNDLETariff does not belong to subscription type in bundled productCheck tariff belongs to bundle subscription type
TARIFF_IS_NOT_AVAILABLE_FOR_SWITCHINGTariff is not available for switching from original tariffVerify tariff allows switching from current tariff
MISSING_MANDATORY_PROMOTIONSThe request is missing mandatory promotions for a tariffAdd all mandatory promotions from catalogue
MISSING_MANDATORY_PROMOTIONS_IN_ADDONThe request is missing mandatory promotions for an addonAdd all mandatory promotions for the addon from catalogue
MISSING_MANDATORY_FREE_UNITS_PACKAGESThe request is missing mandatory free units packagesAdd all mandatory free units packages from catalogue
MISSING_MANDATORY_ADDONSThe request is missing mandatory addonsAdd all mandatory addons from catalogue
MISSING_MANDATORY_COMMERCIAL_DEVICESThe request is missing mandatory commercial devicesAdd all mandatory commercial devices from catalogue
SUBSCRIPTION_MANDATORY_MISMATCHSubscription type mandatory flag does not match catalogue definitionCheck subscription type mandatory flag matches catalogue
BUNDLED_COMMERCIAL_PRODUCT_NOT_FOUNDNo bundled commercial product found for subscription type in bundleVerify bundle contains commercial product for subscription type
BUNDLE_MIGRATION_DESTINATION_BUNDLE_CONFIG_NOT_FOUNDDestination bundle config could not be determined for bundle migrationVerify bundle switching configuration in +Catalogue
ADDRESS_CHANGE_MOBILE_DEVICES_NOT_ALLOWEDDevices related info is not allowed for mobile subscriptions in address changeRemove devices related info from mobile add or modify subscriptions
TECH_CHANGE_MOBILE_DEVICES_NOT_ALLOWEDDevices related info is not allowed for mobile subscriptions in technology changeRemove devices related info from mobile add or modify subscriptions
MIGRATION_CHANGE_BROADBAND_REQUIREDA broadband subscription is required for address or technology change migrationsAdd the broadband subscription to add_subscriptions or modify_subscriptions
MIGRATION_CHANGE_BROADBAND_DUPLICATEDBroadband subscription cannot be sent in both added and modified subscriptionsSend the broadband subscription in either add_subscriptions or modify_subscriptions, not both
MIGRATION_CHANGE_LANDLINE_NOT_ALLOWEDLandline modification is only allowed for address change migrationsSend modify_subscriptions.landline only with type ADDRESS_CHANGE or ADDRESS_AND_TECH_CHANGE
MIGRATION_CHANGE_LANDLINE_MULTIPLEOnly one landline subscription can be modifiedSend a single element in modify_subscriptions.landline
INSURANCE_TYPE_MISSING_IN_BUNDLED_PRODUCTInsurance type not found in bundled commercial productAdd insurance type to bundled commercial product in catalogue
CATALOGUE_DEVICE_ERRORUnable to retrieve catalogue device dataVerify catalogue device exists in +Catalogue

400 Bad Request - Barrings Validation

CodeDescriptionPossible actions
SUBSCRIPTION_HAS_DEBT_MASKThe action is not allowed because subscription is barred for debtClear debt barring before attempting operation
SUBSCRIPTION_ADD_ON_STATUS_DOES_NOT_ALLOW_CHANGE_TARIFFSubscription add-on status does not allow change tariffWait until all subscription add-ons leave preactive status
SUBSCRIPTION_NOT_ACTIVE_ON_THIRD_PARTY_NO_CRSubscription not active on third party does not allow change requestActivate subscription on third party first

400 Bad Request - Sales Promotions

CodeDescriptionPossible actions
INVALID_ACTIVATION_DATEActivation date provided is invalidProvide valid activation date
INVALID_EXPIRATION_DATEExpiration date provided is invalidProvide valid expiration date
INVALID_SUBSCRIPTION_TYPESubscription status does not allow the action requestedCheck subscription status
SUBSCRIPTION_BARREDSubscription barred for debt does not allow the action requestedClear debt barring before proceeding
PROMOTION_STATUS_INVALIDPromotion status does not allow the action requestedCheck promotion status
VALIDATION_DOES_NOT_MATCHConditions evaluated in validation have changedValidate again with current conditions
VALIDATION_EXPIREDValidation expired for the requestRequest new validation
INVALID_CATALOGUE_PROMOTION_IDSubscription is not compatible with requested catalogue promotionCheck promotion compatibility in +Catalogue
CATALOGUE_PROMOTION_ID_IS_BUNDLEDBundle level promotion category is not supported by this serviceUse bundle-level promotion endpoint
NO_VALID_SUBSCRIPTIONSThere are no subscriptions with a valid status for the given bundleCheck subscriptions have valid status
BUNDLE_HAS_NO_ELIGIBLE_SUBSCRIPTIONSThere are no mandatory or bundled subscriptions eligible for the given bundleCheck bundle contains mandatory or bundled subscriptions
PROMOTION_SUBSCRIPTION_HAS_NO_LEGACY_ACCOUNT_IDSubscription has no legacy account id, because the subscription type is not legacy and it has been created by v3. Also, this subscription has no account idCheck subscription data

400 Bad Request - AgileTv Validation

CodeDescriptionPossible actions
AGILE_TV_NOT_MAIN_LINEOnly primary AgileTv subscriptions are allowed in new bundle salesEnsure the bundled commercial product corresponds to a primary AgileTv line
PRIMARY_AGILE_TV_WITHOUT_PROVIDER_IDPrimary AgileTv subscription is missing provider product idRequest the provider product id for the AgileTv commercial product in Catalogue
NO_PRIMARY_AGILE_TV_SUBSCRIPTIONReceived bundled_commercial_product is for a secondary agile tv subscription, but the given account has no primary agile tv subscriptionAdd a primary AgileTv subscription to the account before adding secondary ones

400 Bad Request - MySim Sell Validation

CodeDescriptionPossible actions
NUMBER_IS_IN_USEPhone number in useUse a different phone number
NUMBER_NOT_ACTIVEPhone number is not activeVerify the phone number is active before retry
INTRODUCE_VALID_DOCUMENT_NUMBERInvalid document numberProvide a valid document number
ICCID_IN_USE_2ICCID is already in useUse a different SIM card
PHONE_ALREADY_RESERVED_OTHER_SALEPhone number already reserved for another saleWait for release or use a different number
PORTABILITY_OPERATOR_NOT_ALLOWEDPortability for this operator is not allowedVerify portability is supported for the operator
DUPLICATED_MSISDNThere are duplicated MSISDNsRemove duplicated MSISDNs from the request
INCOMPATIBLE_BUNDLE_PRODUCTIncompatible bundled productSelect a product compatible with the bundle
MISSING_DONOR_ICCMissing donor ICCIDProvide the donor ICCID
NEW_PHONE_NOT_VALIDNew phone is not validProvide a valid phone number
INVALID_SELL_ID_OR_TENANTEither sell ID or tenant is invalidVerify the sell identifier and tenant
SIM_NOT_ASSOCIATED_DEALERSIM card is not associated to dealerUse a SIM card associated with the dealer
DISTRIBUTOR_NOT_EXISTSDistributor does not existVerify the distributor code before retrying
LANDLINE_OPERATOR_NOT_FOUNDLandline operator not foundVerify the landline operator information
COMPANY_NAME_TOO_LONGCompany name too longShorten the company name
AGILE_DOCUMENT_NUMBER_ALREADY_ACTIVEClient document already has an AgileTv service activeUse another customer or remove AgileTv
DIFFERENT_ICCSOrigin ICCID differs from the final ICCIDUse matching origin and final ICCIDs
INVALID_ICCIDInvalid ICCIDProvide a valid ICCID
CUSTOMER_NOT_FOUNDCustomer not foundVerify the customer exists
NOT_ALLOWED_OPERATION_INVALID_BLOCK_ACCOUNT_STATUSOperation not allowed: Contract state is invalidCheck contract status before retrying
NUMBER_ALREADY_ACTIVEPhone number is already activeUse another phone number
MSISDN_USEDMsisdn is in useSelect an unused MSISDN
NOT_MOBILE_NUMBEROne of the provided msisdn is not a valid mobile numberProvide valid mobile numbers

401 Unauthorized

CodeDescriptionPossible actions
UNAUTHORIZEDUser is not authenticatedProvide valid authentication credentials

403 Forbidden

CodeDescriptionPossible actions
FORBIDDENNot authorized to perform the operationCheck user permissions
DEVICE_TRANSFER_BETWEEN_DIFFERENT_ACCOUNTSDevice transfer between different accounts is not allowedVerify both subscriptions belong to the same account
DEVICE_TRANSFER_BETWEEN_DIFFERENT_SERVICESDevice transfer between different Agile TV services is not allowedVerify both subscriptions belong to the same Agile TV service
DEVICE_TRANSFER_BETWEEN_DIFFERENT_SUBSCRIPTION_TYPESDevice transfer between different subscription types is not allowedVerify both subscriptions are of the same type
DEVICE_TRANSFER_WITHIN_SAME_SUBSCRIPTIONDevice transfer within the same subscription is not allowedUse a device from a different subscription
DEVICE_DOES_NOT_BELONG_TO_SUBSCRIPTIONDevice does not belong to subscriptionVerify the device belongs to the requested subscription
UNSUPPORTED_SUBSCRIPTION_OPERATIONThe operation cannot be performed on this subscriptionCheck supported operations for this subscription type
ORANGE_TV_INSTALLATION_STATUS_NOT_ALLOWED_IN_CANCELLATIONInstallation status does not allow cancellationWait for installation to reach cancellable status

404 Not Found

CodeDescriptionPossible actions
NOT_FOUNDResource not foundVerify resource identifier is correct
SUBSCRIPTION_NOT_FOUNDThe requested subscription does not existCheck the subscription id provided
SUBSCRIPTION_NOT_FOUND_WITH_TYPENo subscription found for the requested typeCheck that the account has a subscription of the requested type
BUNDLE_NOT_FOUNDThe requested bundle does not existCheck the bundle id provided
DEVICE_NOT_FOUNDDevice not foundVerify device identifier is correct
PROMOTION_NOT_FOUNDPromotion not foundCheck promotion id provided
BONUS_NOT_FOUNDBonus not foundCheck bonus id provided
CHANGE_REQUEST_NOT_FOUNDChange request not foundVerify change request identifier is correct
COMMITMENT_NOT_FOUND_EXCEPTIONCommitment not foundVerify commitment identifier is correct
CONTRACT_NOT_FOUNDContract not foundVerify contract identifier is correct
DOCUMENTS_CONTRACT_NOT_FOUNDDocuments contract not foundVerify documents contract identifier is correct
ADD_ON_NOT_FOUNDNo addOn found with given idVerify addon identifier is correct
FRAUD_REQUEST_NOT_FOUNDFraud request not foundVerify fraud request identifier is correct
PROMOTION_ID_NOT_FOUNDPromotionId provided is not found for the subscriptionCheck promotion exists in subscription
SALE_PROMOTION_NOT_FOUNDSalePromotion not foundVerify sale promotion identifier is correct
COMMERCIAL_TRANSACTION_NOT_FOUNDCommercial transaction not foundVerify commercial transaction identifier is correct
MIGRATION_CHANGE_LANDLINE_NOT_FOUNDLandline subscription to modify is not an active landline of the bundleUse the id of the active landline subscription of the bundle

406 Not Acceptable

CodeDescriptionPossible actions
NOT_ACCEPTABLERequest content type or format not acceptableCheck Accept headers and request format

409 Conflict

CodeDescriptionPossible actions
CONFLICTResource conflictCheck resource state and resolve conflict
PROMOTION_ALREADY_EXISTSPromotion already existsRemove duplicate promotion or use existing one
INVALID_OPERATION_ON_BUNDLE_STATUSBundle status does not allow operationCheck bundle status before performing operation
UNFINISHED_CHANGE_REQUEST_EXISTSUnfinished change request already exists for subscriptionComplete or cancel existing change request
ORANGE_TV_LIBRE_REGISTRATION_EMAIL_ALREADY_IN_USEOrange TV Libre registration email is already in useUse a different email address
ORANGE_TV_REGISTRATION_EMAIL_ALREADY_IN_USEOrange TV registration email is already in useUse a different email address
SALE_PROMOTION_ALREADY_EXECUTEDSale promotion already executedCannot re-execute already executed promotion
SALE_PROMOTION_ROLLBACK_PENDINGSale promotion rollback is pendingWait for rollback to complete
ACCOUNT_HAS_BUNDLE_COMMERCIAL_TRANSACTION_IN_PROGRESSAccount has a bundle commercial transaction in progressWait for the existing commercial transaction to complete or cancel it
PENDING_REQUESTS_FOR_EXISTING_BUNDLEPending requests for existing bundleWait for pending commercial transactions or change requests to complete
PENDING_DEVICE_SWAP_TRANSACTIONThere is already an active device swap transaction for this subscriptionWait for the existing device swap transaction to complete or cancel it
DEVICE_SUBSCRIPTION_CONCURRENT_MODIFICATIONDevice subscription was modified by another processRetry the operation

409 Conflict - MySim Sell Validation

CodeDescriptionPossible actions
FRAUD_DENIEDRejected by fraudReview fraud result before retrying
CUSTOMER_HAS_WORKORDER_IN_PROGRESSCustomer already has a work order in progressWait for the current work order to finish
SUBSCRIPTION_IN_WAITING_STATUSSubscription is pending terminationWait until termination is completed
PORTABILITY_IN_PROGRESSPortability in progressWait until portability is completed
PORTABILITY_IN_PROGRESS_MY_PORTABILITYPortability in progressWait until portability is completed
PORTABILITY_REJECTED_AND_IN_RETRY_PERIODPortability was rejected and is in retry periodWait until the retry period ends or retry later

409 Conflict - MySim Bundle Migration (Legacy)

CodeDescriptionPossible actions
PORTABILITY_IN_PROGRESS_ERRORPortability already in progress for this MSISDNWait until the ongoing portability completes
SELL_ALREADY_BEEN_REGISTEREDSale already been registeredVerify the sale was not already submitted before retrying
WORK_ORDER_PENDINGWO pendingWait for the pending work order to finish
OPERATION_PENDING_ERROROperation pendingWait for the pending operation to finish
PENDING_EXPEDITION_ERRORThere is a PENDING expedition for this MSISDNWait for the pending expedition to be processed
PENDING_BPM_REQUEST_ERRORThere is a pending BPM request in TV or InternetWait for the pending BPM request to complete
WORK_ORDER_PENDING_OR_NOT_FOUND_ERRORWorkOrder still pending or not foundWait for the work order to finish or verify it exists
PENDING_MOBILE_BPM_REQUESTS_ERRORThere are pending BPM requests for mobileWait for the pending mobile BPM requests to complete
PORTABILITY_REJECTED_ERRORPortability was rejected in MyPortabilityReview the rejection reason in MyPortability before retrying

500 Internal Server Error

CodeDescriptionPossible actions
INTERNAL_SERVER_ERRORInternal server error occurredRetry request or contact support
ACCOUNT_ID_NOT_RESOLVEDAccount id could not be resolved while adding a subscription to a bundleRetry request or contact support if the account exists

500 Internal Server Error - MySim Bundle Migration (Legacy)

CodeDescriptionPossible actions
SUBSCRIPTION_NOT_FOUND_ERRORSubscription does not exist in MySIMVerify the subscription exists in MySIM before retrying
PORTABILITY_ORIGIN_NOT_FOUND_ERRORMissing donor operator informationProvide the donor operator information
INVALID_ADDRESS_ERRORAddress is invalid or does not existProvide a valid existing address
INVALID_DONOR_ICCID_ERRORDonor operator ICCID is not validProvide a valid donor ICCID
PRODUCT_NOT_VALID_FOR_BUNDLE_ERRORProduct is not compatible with bundle migrationSelect a product compatible with bundle migration
INVALID_SELL_XML_ERRORSell XML is malformed or missing mandatory tagsFix the sell XML structure and mandatory tags
INVALID_MANDATORY_PHONE_STATUS_ERRORMandatory mobile line is not in a valid status for migrationEnsure the mandatory mobile line is in a valid status before migrating
INVALID_DELIVERY_TYPE_ERRORDelivery type is not validProvide a valid delivery type
TARIFF_CHANGE_NOT_ALLOWED_ERRORInternet subscription does not allow tariff changeVerify the subscription allows tariff change
OPERATION_NOT_ALLOWED_BY_STATUS_ERRORSubscription is not in ACTIVE statusEnsure the subscription is ACTIVE before retrying
TPC_BLOCKED_OPERATION_ERRORActive TPC is blocking the operationResolve or wait for the active TPC to clear
PRODUCT_WITHOUT_PACK_ERRORAssigned product has no associated packAssign a pack to the product before retrying
USER_WITHOUT_PERMISSION_ERRORUser has no permission for the destination mobile operatorUse a user with permissions for the destination operator
FRAUD_PLATFORM_ERRORError communicating with the fraud scoring platformRetry request or contact support
MANDATORY_MOBILE_NOT_FOUND_ERRORMandatory mobile line for bundle 3P is missingProvide the mandatory mobile line for the bundle 3P
DEALER_CODE_NOT_FOUND_ERRORSHOPID does not exist in MySIMVerify the dealer SHOPID exists in MySIM
DUPLICATED_MSISDN_ERRORMSISDN already exists in the bundleRemove the duplicated MSISDN from the bundle
TV_SUBSCRIPTION_ADDITION_NOT_ALLOWED_ERRORTV installation does not allow adding a subscriptionVerify the TV installation status before adding a subscription
PORTABILITY_BETWEEN_HOSTS_NOT_ALLOWED_ERRORPortability between different hosts is not allowed for this brandVerify portability is supported between hosts for the brand
BILLING_TYPE_NOT_ALLOWED_FOR_HOST_ERRORBillingType is not allowed for this host (YOIGO)Use a BillingType allowed for this host

501 Not Implemented

CodeDescriptionPossible actions
NOT_IMPLEMENTEDFunctionality not yet implementedCheck API documentation for available features

503 Service Unavailable

CodeDescriptionPossible actions
SERVICE_UNAVAILABLEService temporarily unavailableRetry request after some time